What does this signature mean (&) in PHP?

Question

Consider:

public function & get($name, $default = null)

Why &?

Answer 1

It means it returns a reference to the result as opposed to a copy of it.

Returning References in PHP

Answer 2

PHP's pass by reference metacharacter. See Passing by Reference

Answer 3

In PHP's syntax, this means that the function returns a reference instead of a value. For example:

<?php
    $foo = 'foo';

    function & get_foo_ref ()
    {
        global $foo;
        return $foo;
    }

    // Get the reference to variable $foo stored into $bar
    $bar = & get_foo_ref();
    $bar = 'bar';

    echo $foo; // Outputs 'bar', since $bar references to $foo.
?>

In the above example, removing the & from the function declaration would make the $foo variable still contain 'foo', since only the value, not the reference was returned from the function.

This was used more often in PHP4, because it did not pass objects by their reference and cloned them instead. Because of this, object variables had to be passed by reference to avoid unwanted cloning. This is no longer the case in PHP5 and references should not be used for this purpose.

However, functions that return references are not completely useless either (or bad practice, when not used for replacing object references).

For example, personally I've used them when creating a script that passes a "path" to an function, which returns reference to variable in that path allowing me to set value to it and read the value. Due to the recursive nature of the function, returning the reference was needed.

By rithiur