WP_MatchesMapRegex
- Since
- 2.9.0
- Source
wp-includes/class-wp-matchesmapregex.php:14
Helper class to remove the need to use eval to replace $matches[] in query strings.
Compatibility
- WordPress
- since 2.9.0
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0).
Properties · 4
$_matchesarrayprivate- store for matches
$outputstringpublic- store for mapping result
$_subjectstringprivate- subject to perform mapping on (query string containing $matches[] references
$_patternstringpublic- regexp pattern to match $matches[] references
Methods · 4
- __construct()constructor
- apply()Substitute substring matches in subject.
- _map()do the actual mapping
- callback()preg_replace_callback hook
Source code
#[AllowDynamicProperties]class WP_MatchesMapRegex { /** * store for matches * * @var array */ private $_matches; /** * store for mapping result * * @var string */ public $output; /** * subject to perform mapping on (query string containing $matches[] references * * @var string */ private $_subject; /** * regexp pattern to match $matches[] references * * @var string */ public $_pattern = '(\$matches\[[1-9]+[0-9]*\])'; // Magic number. /** * constructor * * @param string $subject subject if regex * @param array $matches data to use in map */ public function __construct( $subject, $matches ) { $this->_subject = $subject; $this->_matches = $matches; $this->output = $this->_map(); } /** * Substitute substring matches in subject. * * static helper function to ease use * * @param string $subject subject * @param array $matches data used for substitution * @return string */ public static function apply( $subject, $matches ) { $result = new WP_MatchesMapRegex( $subject, $matches ); return $result->output; } /** * do the actual mapping * * @return string */ private function _map() { $callback = array( $this, 'callback' ); return preg_replace_callback( $this->_pattern, $callback, $this->_subject ); } /** * preg_replace_callback hook * * @param array $matches preg_replace regexp matches * @return string */ public function callback( $matches ) { $index = (int) substr( $matches[0], 9, -1 ); return ( isset( $this->_matches[ $index ] ) ? urlencode( $this->_matches[ $index ] ) : '' ); }}Changelog
Introduced in 2.9.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/class-wp-matchesmapregex.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.