PHP 5.6 и PHP 7 на русском: Аргументы функции

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

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

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

Пример #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 5.

Объявления типов позволяют функциям строго задавать тип передаваемых параметров. Передача в функцию значений несоответствующего типа будет приводить к ошибке: в PHP 5 это будет обрабатываемая фатальная ошибка, а в PHP 7 будет выбрасываться исключение TypeError.

Чтобы объявить тип агрумента, необходимо перед его именем добавить имя требуемого типа. Также можно объявить тип NULL, чтобы указать, что значением по умолчанию аргумента является NULL.

Valid types

Тип	Описание	Минимальная версия PHP
Имя класса/интерфейса	Агрумент должен быть instanceof, что и имя класса или интерфейса.	PHP 5.0.0
array	Аргумент должен быть типа array.	PHP 5.1.0
callable	Аргумент должен быть корректным callable типом.	PHP 5.4.0
bool	Аргумент должен быть типа boolean.	PHP 7.0.0
float	Аргумент должен быть float типа.	PHP 7.0.0
int	Аргумент должен быть типа integer.	PHP 7.0.0
string	Аргумент должен иметь тип string.	PHP 7.0.0

Примеры

Пример #7 Основные объявления типов-классов


<?php
class C {}
class D extends C {}

// Это не является расширением класса C.
class E {}

function f(C $c) {
    echo get_class($c)."\n";
}

f(new C);
f(new D);
f(new E);
?>

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

C
D

Fatal error: Uncaught TypeError: Argument 1 passed to f() must be an instance of C, instance of E given, called in - on line 14 and defined in -:8
Stack trace:
#0 -(14): f(Object(E))
#1 {main}
  thrown in - on line 8

Пример #8 Основные объявления типов-интерфейсов


<?php
interface I { public function f(); }
class C implements I { public function f() {} }

// Это не реализует интерфейс I.
class E {}

function f(I $i) {
    echo get_class($i)."\n";
}

f(new C);
f(new E);
?>

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

C

Fatal error: Uncaught TypeError: Argument 1 passed to f() must implement interface I, instance of E given, called in - on line 13 and defined in -:8
Stack trace:
#0 -(13): f(Object(E))
#1 {main}
  thrown in - on line 8

Пример #9 Объявление типа Null


<?php
class C {}

function f(C $c = null) {
    var_dump($c);
}

f(new C);
f(null);
?>

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

object(C)#1 (0) {
}
NULL

Строгая типизация

По умолчанию, PHP будет пытаться привести значения несоответствующих типов к скалярному типу, если это возможно. Например, если в функцию передается integer, а тип аргумента объявлен string, в итоге функция получит преобразованное string значение.

Для отдельных файлов можно включать режим строгой типизации. В этом режиме в функцию можно передавать значения только тех типов, которые объявлены для аргументов. В противном случае будет выбрасываться исключение TypeError. Есть лишь одно исключение - integer можно передать в функцию, которая ожидает значение типа float.

Для влючения режима строгой типизации используется выражение declare в объявлении strict_types:

Предостережение

Включение режима строгой типизации также повлияет на объявления типов возвращаемых значений.

Замечание:
Режим строгой типизации распространяется на вызовы функций совершенные из файла, в котором этот режим включен, а не на функции, которые в этом файле объявлены. Если файл без строгой типизации вызывает функцию, которая объявлена в файле с включенным режимом, значения аргументов будут приведены к нужным типам и ошибок не последует.

Замечание:
Строгая типизация применима только к скалярным типам и работает только в PHP 7.0.0 и выше. Равно как и сами объявления скалярных типов добавлены в этой версии.

Пример #10 Строгая типизация


<?php
declare(strict_types=1);

function sum(int $a, int $b) {
    return $a + $b;
}

var_dump(sum(1, 2));
var_dump(sum(1.5, 2.5));
?>

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

int(3)

Fatal error: Uncaught TypeError: Argument 1 passed to sum() must be of the type integer, float given, called in - on line 9 and defined in -:4
Stack trace:
#0 -(9): sum(1.5, 2.5)
#1 {main}
  thrown in - on line 4

Пример #11 Слабая типизация


<?php
function sum(int $a, int $b) {
    return $a + $b;
}

var_dump(sum(1, 2));

// These will be coerced to integers: note the output below!
var_dump(sum(1.5, 2.5));
?>

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

int(3)
int(3)

Пример #12 Обработка исключения TypeError


<?php
declare(strict_types=1);

function sum(int $a, int $b) {
    return $a + $b;
}

try {
    var_dump(sum(1, 2));
    var_dump(sum(1.5, 2.5));
} catch (TypeError $e) {
    echo 'Error: '.$e->getMessage();
}
?>

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

int(3)
Error: Argument 1 passed to sum() must be of the type integer, float given, called in - on line 10

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

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

... в PHP 5.6+

В версиях PHP 5.6 и выше список аргументов может содержать многоточие ..., чтобы показать, что функция принимает переменное количество аргументов. Аргументы в этом случае будут переданы в виде массива. Например:

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


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

echo sum(1, 2, 3, 4);
?>

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

Многоточие (...) можно использовать при вызове функции, чтобы распаковать массив (array) или Traversable переменную в список аргументов:

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


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

echo add(...[1, 2])."\n";

$a = [1, 2];
echo add(...$a);
?>

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

3
3

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

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

Пример #15 Аргументы с подсказкой типов


<?php
function total_intervals($unit, DateInterval ...$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';

// This will fail, since null isn't a DateInterval object.
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 и более ранних:

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


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

echo sum(1, 2, 3, 4);
?>

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

Коментарии

Mar 28

Автор: php at richardneill dot org


To experiment on performance of pass-by-reference and pass-by-value, I used this  script. Conclusions are below. 



#!/usr/bin/php

<?php

function sum($array,$max){   //For Reference, use:  "&$array"

    $sum=0;

    for ($i=0; $i<2; $i++){

        #$array[$i]++;        //Uncomment this line to modify the array within the function.

        $sum += $array[$i];  

    }

    return ($sum);

}



$max = 1E7                  //10 M data points.

$data = range(0,$max,1);



$start = microtime(true);

for ($x = 0 ; $x < 100; $x++){

    $sum = sum($data, $max);

}

$end =  microtime(true);

echo "Time: ".($end - $start)." s\n";



/* Run times:

#    PASS BY    MODIFIED?   Time

-    -------    ---------   ----

1    value      no          56 us

2    reference  no          58 us



3    valuue     yes         129 s

4    reference  yes         66 us



Conclusions:



1. PHP is already smart about zero-copy / copy-on-write. A function call does NOT copy the data unless it needs to; the data is

   only copied on write. That's why  #1 and #2 take similar times, whereas #3 takes 2 million times longer than #4.

   [You never need to use &$array to ask the compiler to do a zero-copy optimisation; it can work that out for itself.]



2. You do use &$array  to tell the compiler "it is OK for the function to over-write my argument in place, I don't need the original

   any more." This can make a huge difference to performance when we have large amounts of memory to copy.

   (This is the only way it is done in C, arrays are always passed as pointers)



3. The other use of & is as a way to specify where data should be *returned*. (e.g. as used by exec() ).

   (This is a C-like way of passing pointers for outputs, whereas PHP functions normally return complex types, or multiple answers

   in an array)



4. It's  unhelpful that only the function definition has &. The caller should have it, at least as syntactic sugar. Otherwise

   it leads to unreadable code: because the person reading the function call doesn't expect it to pass by reference. At the moment,

   it's necessary to write a by-reference function call with a comment, thus:

    $sum = sum($data,$max);  //warning, $data passed by reference, and may be modified.



5. Sometimes, pass by reference could be at the choice of the caller, NOT the function definitition. PHP doesn't allow it, but it

   would be meaningful for the caller to decide to pass data in as a reference. i.e. "I'm done with the variable, it's OK to stomp

   on it in memory".

*/

?>

2015-03-28 21:24:09

http://php5.kiev.ua/manual/ru/functions.arguments.html

Aug 11

Автор: gabriel at figdice dot org


A function's argument that is an object, will have its properties modified by the function although you don't need to pass it by reference.



<?php

$x = new stdClass();

$x->prop = 1;



function f ( $o ) // Notice the absence of &

{

  $o->prop ++;

}



f($x);



echo $x->prop; // shows: 2

?>



This is different for arrays:



<?php

$y = [ 'prop' => 1 ];



function g( $a )

{

  $a['prop'] ++;

  echo $a['prop'];  // shows: 2

}



g($y);



echo $y['prop'];  // shows: 1

?>

2016-08-11 10:05:15

http://php5.kiev.ua/manual/ru/functions.arguments.html

Aug 16

Автор: Hayley Watson


If you use ... in a function's parameter list, you can use it only once for obvious reasons. Less obvious is that it has to be on the LAST parameter; as the manual puts it: "You may specify normal positional arguments BEFORE the ... token. (emphasis mine).



<?php

function variadic($first, ...$most, $last)

{/*etc.*/}



variadic(1, 2, 3, 4, 5);

?>

results in a fatal error, even though it looks like the Thing To Do™ would be to set $first to 1, $most to [2, 3, 4], and $last to 5.

2017-08-16 03:50:21

http://php5.kiev.ua/manual/ru/functions.arguments.html

Aug 31

Автор: Hayley Watson


There are fewer restrictions on using ... to supply multiple arguments to a function call than there are on using it to declare a variadic parameter in the function declaration. In particular, it can be used more than once to unpack arguments, provided that all such uses come after any positional arguments.



<?php



$array1 = [[1],[2],[3]];

$array2 = [4];

$array3 = [[5],[6],[7]];



$result = array_merge(...$array1); // Legal, of course: $result == [1,2,3];

$result = array_merge($array2, ...$array1); // $result == [4,1,2,3]

$result = array_merge(...$array1, $array2); // Fatal error: Cannot use positional argument after argument unpacking.

$result = array_merge(...$array1, ...$array3); // Legal! $result == [1,2,3,5,6,7]

?>



The Right Thing for the error case above would be for $result==[1,2,3,4], but this isn't yet (v7.1.8) supported.

2017-08-31 02:41:01

http://php5.kiev.ua/manual/ru/functions.arguments.html

Feb 08

Автор: boan dot web at outlook dot com


Quote:



"The declaration can be made to accept NULL values if the default value of the parameter is set to NULL."



But you can do this (PHP 7.1+):



<?php

function foo(?string $bar) {

    //...

}



foo(); // Fatal error

foo(null); // Okay

foo('Hello world'); // Okay

?>

2018-02-08 13:27:26

http://php5.kiev.ua/manual/ru/functions.arguments.html

Oct 03

Автор: LilyWhite


It is worth noting that you can use functions as function arguments



<?php

function run($op, $a, $b) {

  return $op($a, $b);

}



$add = function($a, $b) {

  return $a + $b;

};



$mul = function($a, $b) {

  return $a * $b;

};



echo run($add, 1, 2), "\n";

echo run($mul, 1, 2);

?>



Output:

3

2

2021-10-03 15:20:48

http://php5.kiev.ua/manual/ru/functions.arguments.html

Mar 09

Автор: Simmo at 9000 dot 000


For anyone just getting started with php or searching, for an understanding, on what this page describes as a "... token" in Variable-length arguments:

https://www.php.net/manual/en/functions.arguments.php#functions.variable-arg-list

<?php



  func($a, ...$b) 



?>

The 3 dots, or elipsis, or "...", or dot dot dot is sometimes called the "spread operator" in other languages.



As this is only used in function arguments, it is probably not technically an true operator in PHP.  (As of 8.1 at least?).



(With having an difficult to search for name like "... token", I hope this note helps someone).

2022-03-09 07:13:31

http://php5.kiev.ua/manual/ru/functions.arguments.html

Dec 15

Автор: Luna


When using named arguments and adding default values only to some of the arguments, the arguments with default values must be specified at the end or otherwise PHP throws an error:



<?php



function test1($a, $c, $b = 2)

{

    return $a + $b + $c;

}



function test2($a, $b = 2, $c)

{

    return $a + $b + $c;

}



echo test1(a: 1, c: 3)."\n"; // Works

echo test2(a: 1, c: 3)."\n"; // ArgumentCountError: Argument #2 ($b) not passed



?>



I assume that this happens because internally PHP rewrites the calls to something like test1(1, 3) and test2(1, , 3). The first call is valid, but the second obviously isn't.

2022-12-15 20:23:51

http://php5.kiev.ua/manual/ru/functions.arguments.html

Функции, определяемые пользователем

Возврат значений

Функции

PHP Manual

PHP5

Для web разработчика

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

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

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

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

Объявление типов

Valid types

Примеры

Строгая типизация

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

... в PHP 5.6+

Предыдущие версии PHP

Коментарии

PHP5

Для web разработчика

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

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

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

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

Объявление типов

Valid types

Примеры

Строгая типизация

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

... в PHP 5.6+

Предыдущие версии PHP

Коментарии

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