How does the '&' symbol in PHP affect the outcome?

Question

I've written and played around with alot of PHP function and variables where the original author has written the original code and I've had to continue on developing the product ie. Joomla Components/Modules/Plugins and I've always come up with this question:

How does the '&' symbol attached to a function or a variable affect the outcome?

For instance:

$variable1 =& $variable2;

OR

function &usethisfunction() {
}

OR

function usethisfunction(&thisvariable) {
{

I've tried searching through the PHP manual and other related sources but cannot find anything that specifically addresses my question.

Salomesalomi

The second example is not valid PHP code – Hemeralopia

Answer 1

These are known as references.

Here is an example of some "regular" PHP code:

function alterMe($var) {
    $var = 'hello';
}

$test = 'hi';
alterMe($test);
print $test; // prints hi

$a = 'hi';
$b = $a;
$a = 'hello';
print $b; // prints hi

And this is what you can achieve using references:

function alterMe(&$var) {
    $var = 'hello';
}

$test = 'hi';
alterMe($test);
print $test; // prints hello

$a = 'hi';
$b &= $a;
$a = 'hello';
print $b; // prints hello

The nitty gritty details are in the documentation. Essentially, however:

References in PHP are a means to access the same variable content by different names. They are not like C pointers; instead, they are symbol table aliases. Note that in PHP, variable name and variable content are different, so the same content can have different names. The closest analogy is with Unix filenames and files - variable names are directory entries, while variable content is the file itself. References can be likened to hardlinking in Unix filesystem.

Degression

Answer 2

<?php

$a = "hello";   # $a points to a slot in memory that stores "hello"
$b = $a;        # $b holds what $a holds

$a = "world";
echo $b;        # prints "hello"

Now if we add &

$a = "hello";   # $a points to a slot in memory that stores "hello"
$b = &$a;   # $b points to the same address in memory as $a

$a = "world";

# prints "world" because it points to the same address in memory as $a.
# Basically it's 2 different variables pointing to the same address in memory
echo $b;        
?>

Clava

Answer 3

It is a reference. It allows 2 variable names to point to the same content.

Ditchwater