Function __global->match_key_match

Definitions

sources/global3.php

  • See if the current URL matches the given software match-keys.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: bool

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$match_keys mixed No No required parameter N/A N/A Match keys (comma-separated list of match-keys, or array of)
$support_post boolean No No False N/A N/A Check against POSTed data too
$current_params ?array No No Null N/A N/A Parameters to check against (null: get from environment GET/POST) - if set, $support_post is ignored)
$current_zone_name ?ID_TEXT No No Null N/A N/A Current zone name (null: get from environment)
$current_page_name ?ID_TEXT No No Null N/A N/A Current page name (null: get from environment)

Returns

  • Whether there is a match
  • Type: boolean
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * See if the current URL matches the given software match-keys.
 *
 * @param  mixed $match_keys Match keys (comma-separated list of match-keys, or array of)
 * @param  boolean $support_post Check against POSTed data too
 * @param  ?array $current_params Parameters to check against (null: get from environment GET/POST) - if set, $support_post is ignored)
 * @param  ?ID_TEXT $current_zone_name Current zone name (null: get from environment)
 * @param  ?ID_TEXT $current_page_name Current page name (null: get from environment)
 * @return boolean Whether there is a match
 */
function match_key_match($match_keys, bool $support_post = false, ?array $current_params = null, ?string $current_zone_name = null, ?string $current_page_name = null) : bool