A library that handles access to superglobals.
Why create a library for this? WordPress .org does not like plugins to directly access superglobals, so this library was created to handle this in a consistent and safe way and can be included as a composer dependency.
- Installation
- Usage
SuperGlobals::get_get_var( $var, $default = null )SuperGlobals::get_post_var( $var, $default = null )SuperGlobals::get_raw_superglobal( string $superglobal )SuperGlobals::get_sanitized_superglobal( string $superglobal )SuperGlobals::get_server_var( $var, $default = null )SuperGlobals::get_var( $var, $default = null )SuperGlobals::sanitize_deep( $value )
It's recommended that you install SuperGlobals as a project dependency via Composer:
composer require stellarwp/superglobalsWe actually recommend that this library gets included in your project using Strauss.
Luckily, adding Strauss to your
composer.jsonis only slightly more complicated than adding a typical dependency, so checkout our strauss docs.
An important note on namespaces:
The docs will in this repo all use
StellarWP\SuperGlobalsas the base namespace, however, if you are using Strauss to prefix namespaces in your project, you will need to adapt the namespaces accordingly. (Example:Boom\Shakalaka\StellarWP\SuperGlobals)
Get a $_GET value and recursively sanitize it using SuperGlobals::sanitize_deep().
use StellarWP\SuperGlobals\SuperGlobals;
// Get $_GET['post_id']
$var = SuperGlobals::get_get_var( 'post_id' );
// Provide a default value if the variable is not set or fails to sanitize.
$var = SuperGlobals::get_get_var( 'post_id', 12 );Get a $_POST value and recursively sanitize it using SuperGlobals::sanitize_deep().
use StellarWP\SuperGlobals\SuperGlobals;
// Get $_POST['post_id']
$var = SuperGlobals::get_post_var( 'post_id' );
// Provide a default value if the variable is not set or fails to sanitize.
$var = SuperGlobals::get_post_var( 'post_id', 12 );Gets the requested superglobal variable. Options are ENV, GET, POST, REQUEST, or SERVER.
use StellarWP\SuperGlobals\SuperGlobals;
// Get $_ENV
$env = SuperGlobals::get_raw_superglobal( 'ENV' );
// Get $_GET
$get = SuperGlobals::get_raw_superglobal( 'GET' );
// Get $_POST
$post = SuperGlobals::get_raw_superglobal( 'POST' );
// Get $_REQUEST
$request = SuperGlobals::get_raw_superglobal( 'REQUEST' );
// Get $_SERVER
$server = SuperGlobals::get_raw_superglobal( 'SERVER' );Gets the requested superglobal variable, sanitized. Options are ENV, GET, POST, REQUEST, or SERVER.
use StellarWP\SuperGlobals\SuperGlobals;
// Get $_ENV
$env = SuperGlobals::get_sanitized_superglobal( 'ENV' );
// Get $_GET
$get = SuperGlobals::get_sanitized_superglobal( 'GET' );
// Get $_POST
$post = SuperGlobals::get_sanitized_superglobal( 'POST' );
// Get $_REQUEST
$request = SuperGlobals::get_sanitized_superglobal( 'REQUEST' );
// Get $_SERVER
$server = SuperGlobals::get_sanitized_superglobal( 'SERVER' );Get a $_SERVER value and recursively sanitize it using SuperGlobals::sanitize_deep().
use StellarWP\SuperGlobals\SuperGlobals;
// Get $_SERVER['REQUEST_URI']
$var = SuperGlobals::get_server_var( 'REQUEST_URI' );
// Provide a default value if the variable is not set or fails to sanitize.
$var = SuperGlobals::get_server_var( 'REQUEST_URI', 'http://example.com' );Gets a value from $_REQUEST, $_POST, or $_GET and recursively sanitizes it using SuperGlobals::sanitize_deep().
use StellarWP\SuperGlobals\SuperGlobals;
// Get $_REQUEST['post_id'] or $_POST['post_id'] or $_GET['post_id'], wherever it lives.
$var = SuperGlobals::get_var( 'post_id' );
// Provide a default value if the variable is not set or fails to sanitize.
$var = SuperGlobals::get_var( 'post_id', 12 );Sanitizes a value recursively using appropriate sanitization functions depending on the type of the value.
Important
During deep sanitization, any nested array value that cannot be safely sanitized is removed entirely (its key is unset). This is intentional: missing data is safer and more predictable than retaining invalid or corrupted values.
use StellarWP\SuperGlobals\SuperGlobals;
$var = SuperGlobals::sanitize_deep( $some_var );