WP_Rewrite::preg_index( int $number )

Indexes for matches for usage in preg_*() functions.

Description Description

The format of the string is, with empty matches property value, ‘$NUM’. The ‘NUM’ will be replaced with the value in the $number parameter. With the matches property not empty, the value of the returned string will contain that value of the matches property. The format then will be ‘$MATCHES[NUM]’, with MATCHES as the value in the property and NUM the value of the $number parameter.

Top ↑

Parameters Parameters


(int) (Required) Index number.

Top ↑

Return Return


Top ↑

Source Source

File: wp-includes/class-wp-rewrite.php

	public function preg_index( $number ) {
		$match_prefix = '$';
		$match_suffix = '';

		if ( ! empty( $this->matches ) ) {
			$match_prefix = '$' . $this->matches . '[';
			$match_suffix = ']';

		return "$match_prefix$number$match_suffix";

Top ↑

Changelog Changelog

Version Description
1.5.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.