WP_Rewrite

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 16

Every hook that fires from inside WP_Rewrite, in the order it appears in the class, grouped by the method that fires it.

Properties · 30

$permalink_structurestringpublic

Permalink structure for posts.

$use_trailing_slashesboolpublic

Whether to add trailing slashes.

$author_basestringpublic

Base for the author permalink structure (example.com/$author_base/authorname).

$author_structurestringpublic

Permalink structure for author archives.

$date_structurestringpublic

Permalink structure for date archives.

$page_structurestringpublic

Permalink structure for pages.

$search_basestringpublic

Base of the search permalink structure (example.com/$search_base/query).

$search_structurestringpublic

Permalink structure for searches.

$comments_basestringpublic

Comments permalink base.

$pagination_basestringpublic

Pagination permalink base.

$comments_pagination_basestringpublic

Comments pagination permalink base.

$feed_basestringpublic

Feed permalink base.

$comment_feed_structurestringpublic

Comments feed permalink structure.

$feed_structurestringpublic

Feed request permalink structure.

$frontstringpublic

The static portion of the post permalink structure.

$rootstringpublic

The prefix for all permalink structures.

$indexstringpublic

The name of the index file which is the entry point to all requests.

$matchesstringpublic

Variable name to use for regex matches in the rewritten query.

$rulesstring[]public

Rewrite rules to match against the request to find the redirect or query.

$extra_rulesstring[]public

Additional rules added external to the rewrite class.

$extra_rules_topstring[]public

Additional rules that belong at the beginning to match first.

$non_wp_rulesstring[]public

Rules that don't redirect to WordPress' index.php.

$extra_permastructsarray[]public

Extra permalink structures, e.g. categories, added by add_permastruct().

$endpointsarray[]public

Endpoints (like /trackback/) added by add_rewrite_endpoint().

$use_verbose_rulesboolpublic

Whether to write every mod_rewrite rule for WordPress into the .htaccess file.

$use_verbose_page_rulesboolpublic

Could post permalinks be confused with those of pages?

$rewritecodestring[]public

Rewrite tags that can be used in permalink structures.

$rewritereplacestring[]public

Regular expressions to be substituted into rewrite rules in place of rewrite tags, see WP_Rewrite::$rewritecode.

$queryreplacestring[]public

Query variables that rewrite tags map to, see WP_Rewrite::$rewritecode.

$feedsstring[]public

Supported default feeds.

Methods · 38

• using_permalinks()Determines whether permalinks are being used.
• using_index_permalinks()Determines whether permalinks are being used and rewrite module is not enabled.
• using_mod_rewrite_permalinks()Determines whether permalinks are being used and rewrite module is enabled.
• preg_index()Indexes for matches for usage in preg_*() functions.
• page_uri_index()Retrieves all pages and attachments for pages URIs.
• page_rewrite_rules()Retrieves all of the rewrite rules for pages.
• get_date_permastruct()Retrieves date permalink structure, with year, month, and day.
• get_year_permastruct()Retrieves the year permalink structure without month and day.
• get_month_permastruct()Retrieves the month permalink structure without day and with year.
• get_day_permastruct()Retrieves the day permalink structure with month and year.
• get_category_permastruct()Retrieves the permalink structure for categories.
• get_tag_permastruct()Retrieves the permalink structure for tags.
• get_extra_permastruct()Retrieves an extra permalink structure by name.
• get_author_permastruct()Retrieves the author permalink structure.
• get_search_permastruct()Retrieves the search permalink structure.
• get_page_permastruct()Retrieves the page permalink structure.
• get_feed_permastruct()Retrieves the feed permalink structure.
• get_comment_feed_permastruct()Retrieves the comment feed permalink structure.
• add_rewrite_tag()Adds or updates existing rewrite tags (e.g. %postname%).
• remove_rewrite_tag()Removes an existing rewrite tag.
• generate_rewrite_rules()Generates rewrite rules from a permalink structure.
• generate_rewrite_rule()Generates rewrite rules with permalink structure and walking directory only.
• rewrite_rules()Constructs rewrite matches and queries from permalink structure.
• wp_rewrite_rules()Retrieves the rewrite rules.
• refresh_rewrite_rules()Refreshes the rewrite rules, saving the fresh value to the database.
• mod_rewrite_rules()Retrieves mod_rewrite-formatted rewrite rules to write to .htaccess.
• iis7_url_rewrite_rules()Retrieves IIS7 URL Rewrite formatted rewrite rules to write to web.config file.
• add_rule()Adds a rewrite rule that transforms a URL structure to a set of query vars.
• add_external_rule()Adds a rewrite rule that doesn't correspond to index.php.
• add_endpoint()Adds an endpoint, like /trackback/.
• add_permastruct()Adds a new permalink structure.
• remove_permastruct()Removes a permalink structure.
• flush_rules()Removes rewrite rules and then recreate rewrite rules.
• init()Sets up the object's properties.
• set_permalink_structure()Sets the main permalink structure for the site.
• set_category_base()Sets the category base for the category permalink.
• set_tag_base()Sets the tag base for the tag permalink.
• __construct()Constructor - Calls init(), which runs setup.

Source code

View on Trac ↗View on GitHub ↗

25#[AllowDynamicProperties]26class WP_Rewrite {27	/**28	 * Permalink structure for posts.29	 *30	 * @since 1.5.031	 * @var string32	 */33	public $permalink_structure;34 35	/**36	 * Whether to add trailing slashes.37	 *38	 * @since 2.2.039	 * @var bool40	 */41	public $use_trailing_slashes;42 43	/**44	 * Base for the author permalink structure (example.com/$author_base/authorname).45	 *46	 * @since 1.5.047	 * @var string48	 */49	public $author_base = 'author';50 51	/**52	 * Permalink structure for author archives.53	 *54	 * @since 1.5.055	 * @var string56	 */57	public $author_structure;58 59	/**60	 * Permalink structure for date archives.61	 *62	 * @since 1.5.063	 * @var string64	 */65	public $date_structure;66 67	/**68	 * Permalink structure for pages.69	 *70	 * @since 1.5.071	 * @var string72	 */73	public $page_structure;74 75	/**76	 * Base of the search permalink structure (example.com/$search_base/query).77	 *78	 * @since 1.5.079	 * @var string80	 */81	public $search_base = 'search';82 83	/**84	 * Permalink structure for searches.85	 *86	 * @since 1.5.087	 * @var string88	 */89	public $search_structure;90 91	/**92	 * Comments permalink base.93	 *94	 * @since 1.5.095	 * @var string96	 */97	public $comments_base = 'comments';98 99	/**100	 * Pagination permalink base.101	 *102	 * @since 3.1.0103	 * @var string104	 */

Changelog

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/class-wp-rewrite.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.