Function __global->post_param_string

Definitions

sources/global2.php

  • Get the value of the specified POST parameter (i.e. like $_POST[$name]) if it is passed, or the default otherwise.Implements additional security over the direct PHP access mechanism which should not be used.If the requested POST parameter is an array, it will be returned as a comma-delimited string.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$name ID_TEXT No No required parameter N/A N/A The name of the parameter to get
$default ?~mixed No No False N/A N/A The default value to give the parameter if the parameter value is not defined (null: allow missing parameter) (false: give error on missing parameter)
$filters integer No No 7871 N/A N/A A bitmask of INPUT_FILTER_* filters

Returns

  • The parameter value (null: missing)
  • Type: ?string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the value of the specified POST parameter (i.e. like $_POST[$name]) if it is passed, or the default otherwise.Implements additional security over the direct PHP access mechanism which should not be used.If the requested POST parameter is an array, it will be returned as a comma-delimited string.
 *
 * @param  ID_TEXT $name The name of the parameter to get
 * @param  ?~mixed $default The default value to give the parameter if the parameter value is not defined (null: allow missing parameter) (false: give error on missing parameter)
 * @param  integer $filters A bitmask of INPUT_FILTER_* filters
 * @return ?string The parameter value (null: missing)
 */
function post_param_string(string $name, $default = false, int $filters = 7871) : ?string
 

sources/minikernel.php

  • Get the value of the specified POST key, if it is found, or the default otherwise.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: string

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$name ID_TEXT No No required parameter N/A N/A The name of the parameter to get
$default ?~mixed No No False N/A N/A The default value to give the parameter if the parameter value is not defined (null: allow missing parameter) (false: give error on missing parameter)

Returns

  • The value of the parameter (null: not there, and default was null)
  • Type: ?string
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * Get the value of the specified POST key, if it is found, or the default otherwise.
 *
 * @param  ID_TEXT $name The name of the parameter to get
 * @param  ?~mixed $default The default value to give the parameter if the parameter value is not defined (null: allow missing parameter) (false: give error on missing parameter)
 * @return ?string The value of the parameter (null: not there, and default was null)
 */
function post_param_string(string $name, $default = false) : ?string