Function __global->_look_for_match_key_message

Definitions

sources/failure.php

  • See if a match-key message affects the error context we are in. May also internally trigger a redirect.
  • Visibility: public
  • Is abstract?: No
  • Is static?: No
  • Is final?: No
  • Returns: object

Parameters

Name Type Passed by reference? Variadic? Default Set Range Description
$natural_text string No No required parameter N/A N/A Message screen text that is about to be displayed
$only_if_zone boolean No No False N/A N/A Only if it is a zone-level match-key
$only_text_match boolean No No False N/A N/A Whether to only consider text matches, not match-key matches

Returns

  • The message (null: no change)
  • Type: ?Tempcode
  • Set: N/A
  • Range: N/A

Preview

Code (PHP)

/**
 * See if a match-key message affects the error context we are in. May also internally trigger a redirect.
 *
 * @param  string $natural_text Message screen text that is about to be displayed
 * @param  boolean $only_if_zone Only if it is a zone-level match-key
 * @param  boolean $only_text_match Whether to only consider text matches, not match-key matches
 * @return ?Tempcode The message (null: no change)
 */
function _look_for_match_key_message(string $natural_text, bool $only_if_zone = false, bool $only_text_match = false) : ?object