PHP/Superglobals/$ SERVER

From DocForge

$_SERVER is a PHP superglobal array which provides access to information generated by the web server which executed the running PHP script. This array is always automatically within scope (use of a global declaration is not required).

[edit] Contents

The following keys might be found in the $_SERVER array. Few will be available if running PHP from the command line. For examples assume the requested URL is http://example.com/test/index.php?id=1.

argc - Contains the number of command line parameters passed to the script (if run on the command line).

argv - Array of arguments passed to the script. When the script is run on the command line, this gives C-style access to the command line parameters. When called via the GET method, this will contain the query string.

AUTH_TYPE - When running under Apache as a module doing HTTP authentication this variable is set to the authentication type.

DOCUMENT_ROOT - The document root directory under which the current script is executing.

GATEWAY_INTERFACE - The revision of the CGI specification the server is using; i.e. 'CGI/1.1'.

HTTP_ACCEPT - Contents of the Accept: header from the current request, if there is one.

HTTP_ACCEPT_CHARSET - Contents of the Accept-Charset: header from the current request, if there is one. Example: 'iso-8859-1,*,utf-8'.

HTTP_ACCEPT_ENCODING - Contents of the Accept-Encoding: header from the current request, if there is one. Example: 'gzip'.

HTTP_ACCEPT_LANGUAGE - Contents of the Accept-Language: header from the current request, if there is one. Example: 'en'.

HTTP_CONNECTION - Contents of the Connection: header from the current request, if there is one. Example: 'Keep-Alive'.

HTTP_HOST - Contents of the Host: header from the current request, if there is one. Example: example.com.

HTTP_REFERER - The address of the page, if any, which referred the user agent to the current page. This is set by some user agents (e.g. browsers). For most web sites this will not be set for every request which has a referrer.

HTTP_USER_AGENT - Contents of the User-Agent: header from the current request, if there is one. Example: 'Mozilla/4.5 [en] (X11; U; Linux 2.2.9 i586)'. See also: get_browser()

HTTPS - Set to a non-empty value if the script was queried through the HTTPS protocol. Note that when using ISAPI with IIS, the value will be off if the request was not made through the HTTPS protocol.

PATH_TRANSLATED - Filesystem- (not document root-) based path to the current script, after the server has done any virtual-to-real mapping.

Note: As of PHP 4.3.2, PATH_TRANSLATED is no longer set implicitly under the Apache 2 SAPI in contrast to the situation in Apache 1, where it's set to the same value as the SCRIPT_FILENAME server variable when it's not populated by Apache. This change was made to comply with the CGI specification that PATH_TRANSLATED should only exist if PATH_INFO is defined.

Apache 2 users may use AcceptPathInfo On inside httpd.conf to define PATH_INFO.

PHP_AUTH_DIGEST - When running under Apache as module doing Digest HTTP authentication this variable is set to the 'Authorization' header sent by the client (which you should then use to make the appropriate validation).

PHP_AUTH_USER - When running under Apache or IIS (ISAPI on PHP 5) as module doing HTTP authentication this variable is set to the username provided by the user.

PHP_AUTH_PW - When running under Apache or IIS (ISAPI on PHP 5) as module doing HTTP authentication this variable is set to the password provided by the user.

PHP_SELF - The filename of the currently executing script relative to the document root. Example: /test/index.php. If PHP is running from the command line this variable contains the script name. See also: __FILE__

QUERY_STRING - The query string, if any. Example: id=1.

REMOTE_ADDR - The IP address from which the user is viewing the current page.

REMOTE_HOST - The Host name from which the user is viewing the current page. The reverse DNS lookup is based off the REMOTE_ADDR of the user if the web server is configured to create this variable. For example, in Apache you'll need HostnameLookups On inside httpd.conf for it to exist. See also: gethostbyaddr()

REMOTE_PORT - The port being used on the user's machine to communicate with the web server.

REQUEST_METHOD - The request method used to access the page; i.e. 'GET', 'HEAD', 'POST', 'PUT'.

REQUEST_TIME - The timestamp of the start of the request. PHP >= 5.1.0

REQUEST_URI - The relative URL which was given in order to access this page, not including any query string. Example: /test/index.php. To assemble a full URL you might use

'http://'. $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI']

SCRIPT_FILENAME - The absolute pathname of the currently executing script. If a script is executed from the command line as a relative path, such as ../file.php, this will be the relative path specified by the user.

SCRIPT_NAME - Contains the current script's path. See also: __FILE__

SERVER_ADDR - The IP address of the server under which the current script is executing.

SERVER_ADMIN - The value given to the SERVER_ADMIN (for Apache) directive in the web server configuration file. If the script is running on a virtual host, this will be the value defined for that virtual host.

SERVER_NAME - The name of the server host under which the current script is executing. If the script is running on a virtual host, this will be the value defined for that virtual host.

SERVER_PORT - The port on the server machine being used by the web server for communication.

SERVER_PROTOCOL - Name and revision of the information protocol via which the page was requested; i.e. 'HTTP/1.0'.

SERVER_SIGNATURE - String containing the server version and virtual host name which are added to server-generated pages, if enabled.

SERVER_SOFTWARE - Server identification string, given in the headers when responding to requests.