WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Rewrite::wp_rewrite_rules()

WP_Rewrite::wp_rewrite_rules(): string[]

In this article

Back to top

Retrieves the rewrite rules.

Description

The difference between this method and WP_Rewrite::rewrite_rules() is that this method stores the rewrite rules in the ‘rewrite_rules’ option and retrieves it. This prevents having to process all of the permalinks to get the rewrite rules in the form of caching.

Return

string[] Array of rewrite rules keyed by their regex pattern.

More Information

It returns the array of rewrite rules as in rewrite_rules(), but using $matches[xxx] in the (where xxx is a number) instead of the normal mod_rewrite backreferences, $xxx (where xxx is a number). This is useful when you’re going to be using the rules inside PHP, rather than writing them out to a .htaccess file.

Source

public function wp_rewrite_rules() {
	$this->rules = get_option( 'rewrite_rules' );
	if ( empty( $this->rules ) ) {
		$this->refresh_rewrite_rules();
	}

	return $this->rules;
}

View all references View on Trac View on GitHub

UsesDescription
WP_Rewrite::refresh_rewrite_rules()wp-includes/class-wp-rewrite.php

Refreshes the rewrite rules, saving the fresh value to the database.

get_option()wp-includes/option.php

Retrieves an option value based on an option name.

Used byDescription
WP::parse_request()wp-includes/class-wp.php

Parses the request to find the correct WordPress query.

url_to_postid()wp-includes/rewrite.php

Examines a URL and try to determine the post ID it represents.

Changelog

VersionDescription
1.5.0Introduced.

User Contributed Notes

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