Difference between revisions of "Rewrite API"

Latest revision as of 11:39, 3 April 2017

Languages: English • API 日本語 (Add your language)

1 Description
2 API Reference

Description

WordPress allows theme and plugin developers to programmatically specify new, custom rewrite rules. The following functions (which are mostly aliases for WP_Rewrite methods) can be used to achieve this.

Note that these rules are usually called inside the init hook. Furthermore, permalinks will need to be refreshed (you can do this from your admin under (Settings > Permalinks) before the rewrite changes will take effect. Requires one-time use of flush_rules() to take effect. See also Flushing Rewrite on Activation.

API Reference

Articles

Lesson: Rewrite API Overview
Class: WP_Rewrite() - An overview of WordPress's built-in URL rewrite class.

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

add_rewrite_tag() - Can be used to allow WordPress to recognize custom variables (particularly custom querystring variables).
add_rewrite_rule() - Allows you to specify new, custom rewrite rules.
add_rewrite_endpoint() - Add a new endpoint like /trackback/
flush_rules() - Regenerate the rewrite rules and save them to the database.
flush_rewrite_rules() - Remove rewrite rules and then recreate rewrite rules.
generate_rewrite_rules() - Generates rewrite rules from a permalink structure
add_permastruct() - Add a new permastruct
add_feed()- Add a new feed type like /atom1/

@@ Line 1: / Line 1: @@
+{{Languages|
+{{en|Rewrite API}}
+{{ja|Rewrite API}}
+}}
 ==Description==
 WordPress allows theme and plugin developers to programmatically specify new, custom rewrite rules. The following functions (which are mostly aliases for [[Function_Reference/WP_Rewrite|WP_Rewrite]] methods) can be used to achieve this.
-Note that these rules are usually called inside the init hook. Furthermore, permalinks will need to be refreshed (you can do this from your admin under Settings > Permalinks) before the rewrite changes will take effect.  Requires one-time use of flush_rules() to take effect.
+Note that these rules are usually called inside the <code>init</code> hook. Furthermore, permalinks will need to be refreshed (you can do this from your admin under (Settings > Permalinks) before the rewrite changes will take effect.  Requires one-time use of flush_rules() to take effect. See also [[Function_Reference/register_post_type#Flushing_Rewrite_on_Activation|Flushing Rewrite on Activation]].
 ==API Reference==

Codex