文档中函数参数的语法

时间:2018-08-14 12:55:42

标签: php syntax documentation

能否请您解释函数中的文档语法。例如php函数

int preg_match ( string $pattern , string $subject [, array &$matches [, int $flags = 0 [, int $offset = 0 ]]] )

到目前为止,我知道函数的参数在圆括号中,方括号也表示数组。但是,[,是什么意思 以及为什么$ subject之后没有逗号?

3 个答案:

答案 0 :(得分:3)

[]中的参数是可选的。 [,表示如果要在此之后指定参数,则必须添加,。使用该函数时,您不必编写[]

而且您不必指定每个参数的类型,它在文档中显示,可以使您知道必须传递的内容。

文档中包含=的参数通常是可选的,文档中等号之后的值表示默认值。

答案 1 :(得分:1)

这就是PHP如何记录可选参数的方式。您不必为这些使用方括号。

因此,您只需要提供$ pattern和$ subject即可为$ matches提供一个引用数组,为$ flags提供一个整数,为$ offset提供一个整数。

如果不提供可选参数,则$ subject后将不会有逗号,因此为什么要放在方括号中。

答案 2 :(得分:1)

在这里,方括号与数组无关,它们表示参数是可选的。

有关如何在PHP文档中读取函数定义的更多信息,请参见:http://php.net/manual/en/about.prototypes.php