VariablesBasics
Variables in PHP are represented by a dollar sign followed by the
name of the variable. The variable name is case-sensitive.
A valid variable name starts with a letter
(A-Z, a-z, or the bytes from 128 through 255)
or underscore, followed
by any number of letters, numbers, or underscores. As a regular
expression, it would be expressed thus:
^[a-zA-Z_\x80-\xff][a-zA-Z0-9_\x80-\xff]*$
PHP doesn't support Unicode variable names, however, some character
encodings (such as UTF-8) encode characters in such a way that all bytes
of a multi-byte character fall within the allowed range, thus making it a
valid variable name.
$this is a special variable that can't be
assigned.
Prior to PHP 7.1.0, indirect assignment (e.g. by using
variable variables)
was possible.
&tip.userlandnaming;
Valid variable names
]]>
Invalid variable names
PHP accepts a sequence of any bytes as a variable name. Variable
names that do not follow the above-mentioned naming rules can only be
accessed dynamically at runtime. See
variable variables
for information on how to access them.
Accessing obscure variable names
]]>
&example.outputs;
By default, variables are always assigned by value. That is to say,
when an expression is assigned to a variable, the entire value of
the original expression is copied into the destination
variable. This means, for instance, that after assigning one
variable's value to another, changing one of those variables will
have no effect on the other. For more information on this kind of
assignment, see the chapter on Expressions.
PHP also offers another way to assign values to variables:
assign by reference.
This means that the new variable simply references (in other words,
"becomes an alias for" or "points to") the original variable.
Changes to the new variable affect the original, and vice versa.
To assign by reference, simply prepend an ampersand (&) to the
beginning of the variable which is being assigned (the source
variable). For instance, the following code snippet outputs 'My
name is Bob' twice:
]]>
One important thing to note is that only variables may be
assigned by reference.
]]>
It is not necessary to declare variables in PHP, however, it is a very
good practice. Accessing an undefined variable will result in an
E_WARNING (prior to PHP 8.0.0, E_NOTICE).
An undefined variable has a default value of &null;.
The isset language
construct can be used to detect if a variable has already been initialized.
Default value of an uninitialized variable
]]>
&example.outputs;
PHP allows array autovivification (automatic creation of new arrays)
from an undefined variable.
Appending an element to an undefined variable will create a new array and
will not generate a warning.
Autovivification of an array from an undefined variable
]]>
Relying on the default value of an uninitialized variable is problematic
when including one file in another which uses the same
variable name.
A variable can be destroyed by using the unset
language construct.
For information on variable-related functions, see the
Variable Functions Reference.
Predefined Variables
PHP provides a number of
predefined variables.
PHP also provides an additional set of predefined arrays
containing variables from the web server (if applicable), the
environment, and user input. These arrays are automatically available in
every scope. For this reason, they are often known as
"superglobals". (There is no mechanism in PHP for
user-defined superglobals.) Refer to the
list of superglobals
for details.
Variable variables
Superglobals cannot be used as
variable variables
inside functions or class methods.
If certain variables in variables_order are not set, their
appropriate PHP predefined arrays are also left empty.
Variable scope
The scope of a variable is the context within which it is defined.
PHP has a function scope and a global scope.
Any variable defined outside a function is limited to the global scope.
When a file is included, the code it contains inherits the variable scope
of the line on which the include occurs.
Example of global variable scope
]]>
Any variable created inside a named function or an
anonymous function
is limited to the scope of the function body.
However, arrow functions
bind variables from the parent scope to make them available inside the body.
If a file include occurs inside a function within
the calling file, the variables contained in the called file will be
available as if they had been defined inside the calling function.
Example of local variable scope
]]>
The example above will generate an undefined variable E_WARNING
(or an E_NOTICE prior to PHP 8.0.0).
This is because the echo statement
refers to a local version of the $a variable,
and it has not been assigned a value within this scope.
Note that this is a little bit different from the C language in
that global variables in C are automatically available to
functions unless specifically overridden by a local definition.
This can cause some problems in that people may inadvertently
change a global variable. In PHP global variables must be
declared global inside a function if they are going to be used in
that function.
The global keyword
The global keyword is used to bind a variable
from a global scope into a local scope. The keyword can be used with
a list of variables or a single variable. A local variable will be created
referencing the global variable of the same name. If the global
variable does not exist, the variable will be created in global scope and
assigned &null;.
Using global
]]>
&example.outputs;
By declaring
$a and $b global within the
function, all references to either variable will refer to the
global version. There is no limit to the number of global
variables that can be manipulated by a function.
A second way to access variables from the global scope is to use
the special PHP-defined $GLOBALS array. The
previous example can be rewritten as:
Using $GLOBALS instead of global
]]>
The $GLOBALS array is an associative array with
the name of the global variable being the key and the contents of
that variable being the value of the array element.
Notice how $GLOBALS exists in any scope, this
is because $GLOBALS is a superglobal.
Here's an example demonstrating the power of superglobals:
Example demonstrating superglobals and scope
]]>
Using global keyword outside a function is not an
error. It can be used if the file is included from inside a function.
Using static variables
Another important feature of variable scoping is the
static variable. A static variable exists
only in a local function scope, but it does not lose its value
when program execution leaves this scope. Consider the following
example:
Example demonstrating need for static variables
]]>
This function is quite useless since every time it is called it
sets $a to 0 and prints
0. The $a++ which increments the
variable serves no purpose since as soon as the function exits the
$a variable disappears. To make a useful
counting function which will not lose track of the current count,
the $a variable is declared static:
Example use of static variables
]]>
Now, $a is initialized only in first call of function
and every time the test() function is called it will print the
value of $a and increment it.
Static variables also provide one way to deal with recursive
functions. The following
simple function recursively counts to 10, using the static
variable $count to know when to stop:
Static variables with recursive functions
]]>
Prior to PHP 8.3.0, static variables could only be initialized using
a constant expression. As of PHP 8.3.0, dynamic expressions
(e.g. function calls) are also allowed:
Declaring static variables
]]>
Static variables inside anonymous functions persist only within that
specific function instance. If the anonymous function is recreated on each
call, the static variable will be reinitialized.
Static variables in anonymous functions
]]>
As of PHP 8.1.0, when a method using static variables is inherited (but not overridden),
the inherited method will now share static variables with the parent method.
This means that static variables in methods now behave the same way as static properties.
As of PHP 8.3.0, static variables can be initialized with arbitrary expressions.
This means that method calls, for example, can be used to initialize static variables.
Usage of static Variables in Inherited Methods
]]>
References with global and static variables
PHP implements the
static and
global modifier
for variables in terms of
references. For example, a true global variable
imported inside a function scope with the global
statement actually creates a reference to the global variable. This can
lead to unexpected behaviour which the following example addresses:
]]>
&example.outputs;
A similar behaviour applies to the static statement.
References are not stored statically:
property)) {
$obj->property = 1;
} else {
$obj->property++;
}
return $obj;
}
function &get_instance_noref() {
static $obj;
echo 'Static object: ';
var_dump($obj);
if (!isset($obj)) {
$new = new stdClass;
// Assign the object to the static variable
$obj = $new;
}
if (!isset($obj->property)) {
$obj->property = 1;
} else {
$obj->property++;
}
return $obj;
}
$obj1 = get_instance_ref();
$still_obj1 = get_instance_ref();
echo "\n";
$obj2 = get_instance_noref();
$still_obj2 = get_instance_noref();
?>
]]>
&example.outputs;
int(1)
}
]]>
This example demonstrates that when assigning a reference to a static
variable, it is not remembered when the
&get_instance_ref() function is called a second time.
Variable variables
Sometimes it is convenient to be able to have variable variable
names. That is, a variable name which can be set and used
dynamically. A normal variable is set with a statement such as:
]]>
A variable variable takes the value of a variable and treats that
as the name of a variable. In the above example,
hello, can be used as the name of a variable
by using two dollar signs. i.e.
]]>
At this point two variables have been defined and stored in the
PHP symbol tree: $a with contents "hello" and
$hello with contents "world". Therefore, this
statement:
]]>
produces the exact same output as:
]]>
i.e. they both produce: hello world.
In order to use variable variables with arrays,
an ambiguity problem has to be resolved. That is, if the parser sees
$$a[1] then it needs to know if
$a[1] was meant to be used as a variable, or if
$$a was wanted as the variable and then the [1]
index from that variable. The syntax for resolving this ambiguity
is: ${$a[1]} for the first case and
${$a}[1] for the second.
Class properties may also be accessed using variable property names. The
variable property name will be resolved within the scope from which the
call is made. For instance, if there is an expression such as
$foo->$bar, then the local scope will be examined for
$bar and its value will be used as the name of the
property of $foo. This is also true if
$bar is an array access.
Curly braces may also be used to clearly delimit the property
name. They are most useful when accessing values within a property that
contains an array, when the property name is made of multiple parts,
or when the property name contains characters that are not
otherwise valid (e.g. from json_decode
or SimpleXML).
Variable property example
$bar . "\n";
echo $foo->{$baz[1]} . "\n";
$start = 'b';
$end = 'ar';
echo $foo->{$start . $end} . "\n";
$arr = 'arr';
echo $foo->{$arr[1]} . "\n";
echo $foo->{$arr}[1] . "\n";
?>
]]>
&example.outputs;
Please note that variable variables cannot be used with PHP's
Superglobal arrays
within functions or class methods. The variable $this
is also a special variable that cannot be referenced dynamically.
Variables From External SourcesHTML Forms (GET and POST)
When a form is submitted to a PHP script, the information from
that form is automatically made available to the script. There
are few ways to access this information, for example:
A simple HTML form
Name:
Email:
]]>
There are only two ways to access data from HTML forms.
Currently available methods are listed below:
Accessing data from a simple POST HTML form
]]>
Using a GET form is similar except the appropriate
GET predefined variable can be used instead. GET also applies to the
QUERY_STRING (the information after the '?' in a URL). So,
for example, http://www.example.com/test.php?id=3
contains GET data which is accessible with $_GET['id'].
See also $_REQUEST.
Dots and spaces in variable names are converted to underscores. For
example <input name="a.b" /> becomes
$_REQUEST["a_b"].
PHP also understands arrays in the context of form variables
(see the related faq).
For example, related variables may be grouped together, or this
feature may be used to retrieve values from a multiple select input. For
example, let's post a form to itself and upon submission display
the data:
More complex form variables
';
echo htmlspecialchars(print_r($_POST, true));
echo '';
}
?>
]]>
If an external variable name begins with a valid array syntax, trailing characters
are silently ignored. For example, <input name="foo[bar]baz">
becomes $_REQUEST['foo']['bar'].
IMAGE SUBMIT variable names
When submitting a form, it is possible to use an image instead
of the standard submit button with a tag like:
]]>
When the user clicks somewhere on the image, the accompanying
form will be transmitted to the server with two additional
variables, sub_x and sub_y.
These contain the coordinates of the
user click within the image. The experienced may note that the
actual variable names sent by the browser contains a period
rather than an underscore, but PHP converts the period to an
underscore automatically.
HTTP Cookies
PHP transparently supports HTTP cookies as defined by RFC 6265. Cookies are a
mechanism for storing data in the remote browser and thus
tracking or identifying return users. It is possible to set cookies using
the setcookie function. Cookies are part of
the HTTP header, so the SetCookie function must be called before
any output is sent to the browser. This is the same restriction
as for the header function. Cookie data
is then available in the appropriate cookie data arrays, such
as $_COOKIE as well as in $_REQUEST.
See the setcookie manual page for more details and
examples.
As of PHP 7.2.34, 7.3.23 and 7.4.11, respectively, the names
of incoming cookies are no longer url-decoded for security reasons.
If multiple values should be assigned to a single cookie variable,
they can be assigned as an array. For example:
]]>
That will create two separate cookies although MyCookie will now
be a single array in the script. If just one cookie should be set
with multiple values, consider using serialize or
explode on the value first.
Note that a cookie will replace a previous cookie by the same
name in the browser unless the path or domain is different. So,
for a shopping cart application a counter may be kept,
and passed along. I.e.
A setcookie example
]]>
Dots in incoming variable names
Typically, PHP does not alter the names of variables when they
are passed into a script. However, it should be noted that the
dot (period, full stop) is not a valid character in a PHP
variable name. For the reason, look at it:
]]>
Now, what the parser sees is a variable named
$varname, followed by the string concatenation
operator, followed by the barestring (i.e. unquoted string which
doesn't match any known key or reserved words) 'ext'. Obviously,
this doesn't have the intended result.
For this reason, it is important to note that PHP will
automatically replace any dots in incoming variable names with
underscores.
Determining variable types
Because PHP determines the types of variables and converts them
(generally) as needed, it is not always obvious what type a given
variable is at any one time. PHP includes several functions
which find out what type a variable is, such as:
gettype, is_array,
is_float, is_int,
is_object, and
is_string. See also the chapter on
Types.
HTTP being a text protocol, most, if not all, content that comes in
Superglobal arrays,
like $_POST and $_GET will remain
as strings. PHP will not try to convert values to a specific type.
In the example below, $_GET["var1"] will contain the
string "null" and $_GET["var2"], the string "123".
&reftitle.changelog;
&Version;&Description;7.2.34, 7.3.23, 7.4.11
The names of incoming cookies are no longer url-decoded
for security reasons.