WordPress.org

Codex

Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Plugin API/Action Reference/generate rewrite rules

This page is marked as incomplete. You can help Codex by expanding it.

Description

Triggers after all rewrite rules have been created. The rewrite object is passed as argument by reference.

Example

An example of adding new endpoint to Rewrite Rules.

function codex_custom_endpoint( $wp_rewrite ) {
    $feed_rules = array(
	  'my-account/?$' => 'index.php?account-page=true',
	  'my-account/edit-profile/?$' => 'index.php?account-edit-profile=true',
    );

    $wp_rewrite->rules = $feed_rules + $wp_rewrite->rules;
    return $wp_rewrite->rules;
}

add_filter( 'generate_rewrite_rules', 'codex_custom_endpoint' );

Related

Articles

Hooks

  • Filter: root_rewrite_rules - Filters the rewrite rules generated for the root of your weblog.
  • Filter: post_rewrite_rules - Filters the rewrite rules generated for permalink URLs.
  • Filter: page_rewrite_rules - Filters the rewrite rules generated for your Pages.
  • Filter: date_rewrite_rules - Filters the rewrite rules generated for dated archive URLs.
  • Filter: search_rewrite_rules - Filters the rewrite rules generated for search URLs.
  • Filter: comments_rewrite_rules - Filters the rewrite rules generated for the latest comment feed URLs.
  • Filter: author_rewrite_rules - Filters the rewrite rules generated for author archive URLs.
  • Filter: rewrite_rules_array - Filters all the rewrite rules at once.
  • Filter: {$permastruct}_rewrite_rules - Can be used to create or modify rewrite rules for any custom permastructs, such as taxonomies or custom post types.
  • Action: generate_rewrite_rules - Runs after all the rules have been created.

Functions