Аргументы функции


Функция может принимать информацию в виде списка аргументов, который является списком разделенных запятыми выражений. Аргументы вычисляются слева направо.

PHP поддерживает передачу аргументов по значению (по умолчанию), передачу аргументов по ссылке, и значения по умолчанию. Списки аргументов переменной длины также поддерживаются.

Пример #1 Передача массива в функцию

<?php
function takes_array($input)
{
    echo 
"$input[0] + $input[1] = "$input[0]+$input[1];
}
?>

Передача аргументов по ссылке

По умолчанию аргументы в функцию передаются по значению (это означает, что если вы измените значение аргумента внутри функции, то вне ее значение все равно останется прежним). Если вы хотите разрешить функции модифицировать свои аргументы, вы должны передавать их по ссылке.

Если вы хотите, что бы аргумент всегда передавался по ссылке, вы можете указать амперсанд (&) перед именем аргумента в описании функции:

Пример #2 Передача аргументов по ссылке

<?php
function add_some_extra(&$string)
{
    
$string .= 'и кое-что еще.';
}
$str 'Это строка, ';
add_some_extra($str);
echo 
$str;    // выведет 'Это строка, и кое-что еще.'
?>

Значения аргументов по умолчанию

Функция может определять значения по умолчанию в стиле C++ для скалярных аргументов, например:

Пример #3 Использование значений по умолчанию в определении функции

<?php
function makecoffee($type "капуччино")
{
    return 
"Готовим чашку $type.\n";
}
echo 
makecoffee();
echo 
makecoffee(null);
echo 
makecoffee("эспрессо");
?>

Результат выполнения данного примера:

 Готовим чашку капуччино. Готовим чашку . Готовим чашку эспрессо. 

PHP также позволяет использовать массивы (array) и специальный тип NULL в качестве значений по умолчанию, например:

Пример #4 Использование нескалярных типов в качестве значений по умолчанию

<?php
function makecoffee($types = array("капуччино"), $coffeeMaker NULL)
{
    
$device is_null($coffeeMaker) ? "вручную" $coffeeMaker;
    return 
"Готовлю чашку ".join(", "$types).$device.\n";
}
echo 
makecoffee();
echo 
makecoffee(array("капуччино""лавацца"), "в чайнике");
?>

Значение по умолчанию должно быть константным выражением, а не (к примеру) переменной или вызовом функции/метода класса.

Обратите внимание, что все аргументы, для которых установлены значения по умолчанию, должны находиться правее аргументов, для которых значения по умолчанию не заданы, в противном случае ваш код может работать не так, как вы этого ожидаете. Рассмотрим следующий пример:

Пример #5 Некорректное использование значений по умолчанию

<?php
function makeyogurt($type "ацидофил"$flavour)
{
    return 
"Готовим чашку из бактерий $type со вкусом $flavour.\n";
}
 
echo 
makeyogurt("малины");   // Не будет работать так, как мы могли бы ожидать
?>

Результат выполнения данного примера:

 Warning: Missing argument 2 in call to makeyogurt() in  /usr/local/etc/httpd/htdocs/phptest/functest.html on line 41 Готовим чашку из бактерий малины со вкусом . 

Теперь сравним эго со следующим примером:

Пример #6 Корректное использование значений по умолчанию

<?php
function makeyogurt($flavour$type "ацидофил")
{
    return 
"Готовим чашку из бактерий $type со вкусом $flavour.\n";
}
 
echo 
makeyogurt("малины");   // отрабатывает правильно
?>

Результат выполнения данного примера:

 Готовим чашку из бактерий ацидофил со вкусом малины. 

Замечание: Начиная с PHP 5, аргументы, передаваемые по ссылке, могут иметь значения по умолчанию.

Списки аргументов переменной длины

PHP поддерживает списки аргументов переменной длины для функций, определяемых пользователем. Это реализуется с помощью символов ... в PHP 5.6 и новее, и с помощью func_num_args(), func_get_arg(), и func_get_args() функциями в PHP 5.5 и более ранних.

... в PHP 5.6+

В PHP 5.6 и более поздних версиях, список аргументов может содержать символы ... указывающие на то, что функция может принимать переменное количество аргументов. Аргументы будут переданы в указанную переменную в виде массива. Пример: variable number of arguments. The arguments will be passed into the given variable as an array; for example:

Пример #7 Использование ... для получения аргументов

<?php
function sum(...$numbers) {
    
$acc 0;
    foreach (
$numbers as $n) {
        
$acc += $n;
    }
    return 
$acc;
}

echo 
sum(1234);
?>

Результат выполнения данного примера:

 10 

Вы также можете использовать ... при вызове функции для разворачивания массива array или объекта Traversable в аргументы функции:

Пример #8 Использование ... при передаче аргументов

<?php
function add($a$b) {
    return 
$a $b;
}

echo 
add(...[12])."\n";

$a = [12];
echo 
add(...$a);
?>

Результат выполнения данного примера:

 3 3 

Вы можете указывать обычные аргументы перед .... В этом случае в массив, создаваемый ..., будут добавлены только те аргументы, которые расположены после обычных.

Также можно добавлять указание типа перед .... В этом случае все аргументы попадающие под действие ... должны быть указанного типа или класса.

Пример #9 Указание типа для списка аргументов переменной длины

<?php
function total_intervals($unitDateInterval ...$intervals) {
    
$time 0;
    foreach (
$intervals as $interval) {
        
$time += $interval->$unit;
    }
    return 
$time;
}

$a = new DateInterval('P1D');
$b = new DateInterval('P2D');
echo 
total_intervals('d'$a$b).' days';

// Не выполнится, так как это не объект класса DateInterval.
echo total_intervals('d'null);
?>

Результат выполнения данного примера:

 3 days Catchable fatal error: Argument 2 passed to total_intervals() must be an instance of DateInterval, null given, called in - on line 14 and defined in - on line 2 

Также вы можете передавать аргументы по ссылке указав перед ... символ амперсанда (&).

Старые версии PHP

Специальный синтаксис для указания списка аргументов переменной длины отсутвует. Доступ к таким аргументам осуществляется с помощью функций func_num_args(), func_get_arg() и func_get_args().

Следующий пример показывает, что нужно делать в PHP 5.5 и ранее:

Пример #10 Доступ к аргументам в PHP 5.5 и ранее

<?php
function sum() {
    
$acc 0;
    foreach (
func_get_args() as $n) {
        
$acc += $n;
    }
    return 
$acc;
}

echo 
sum(1234);
?>

Результат выполнения данного примера:

 10