Query: session_register
OS: php
Section: 3
Format: Original Unix Latex Style Formatted with HTML and a Horizontal Scroll Bar
SESSION_REGISTER(3) 1 SESSION_REGISTER(3) session_register - Register one or more global variables with the current sessionSYNOPSISbool session_register (mixed $name, [mixed $...])DESCRIPTIONsession_register(3) accepts a variable number of arguments, any of which can be either a string holding the name of a variable or an array consisting of variable names or other arrays. For each name, session_register(3) registers the global variable with that name in the cur- rent session. You can also create a session variable by simply setting the appropriate member of the $_SESSION or $HTTP_SESSION_VARS (PHP < 4.1.0) array. <?php // Use of session_register() is deprecated $barney = "A big purple dinosaur."; session_register("barney"); // Use of $_SESSION is preferred, as of PHP 4.1.0 $_SESSION["zim"] = "An invader from another planet."; // The old way was to use $HTTP_SESSION_VARS $HTTP_SESSION_VARS["spongebob"] = "He's got square pants."; ?> If session_start(3) was not called before this function is called, an implicit call to session_start(3) with no parameters will be made. $_SESSION does not mimic this behavior and requires session_start(3) before use. Warning This function has been DEPRECATED as of PHP 5.3.0 and REMOVED as of PHP 5.4.0.PARAMETERSo $name - A string holding the name of a variable or an array consisting of variable names or other arrays. o $... -RETURN VALUESReturns TRUE on success or FALSE on failure.NOTESCaution If you want your script to work regardless of register_globals, you need to instead use the $_SESSION array as $_SESSION entries are automatically registered. If your script uses session_register(3), it will not work in environments where the PHP directive reg- ister_globals is disabled. Note register_globals: important note As of PHP 4.2.0, the default value for the PHP directive register_globals is off. The PHP community discourages developers from relying on this directive, and encourages the use of other means, such as the superglobals. Caution This registers a global variable. If you want to register a session variable from within a function, you need to make sure to make it global using the global keyword or the $GLOBALS[] array, or use the special session arrays as noted below. Caution If you are using $_SESSION (or $HTTP_SESSION_VARS), do not use session_register(3), session_is_registered(3), and session_unregis- ter(3). Note It is currently impossible to register resource variables in a session. For example, you cannot create a connection to a database and store the connection id as a session variable and expect the connection to still be valid the next time the session is restored. PHP functions that return a resource are identified by having a return type of resource in their function definition. A list of functions that return resources are available in the resource types appendix. If $_SESSION (or $HTTP_SESSION_VARS for PHP 4.0.6 or less) is used, assign values to $_SESSION. For example: $_SESSION['var'] = 'ABC';SEE ALSOsession_is_registered(3), session_unregister(3), $_SESSION. PHP Documentation Group SESSION_REGISTER(3)