WordPress.org

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

Description

add_permastruct() allows you to specify additional permalink structures for WordPress. It is most commonly used in conjunction with add_rewrite_tag() and add_rewrite_rule()

Usage

add_permastruct($name, $struct, $args);

Parameters

$name

(string) (required) Name for permalink structure.

Default: None

$struct

(string) (required) Permalink structure.

Default: None

$args

(array) (optional) Optional configuration for building the rules from the permalink structure, see WP_Rewrite::add_permastruct() for full details.

Default: array

Possible Arguments

with_front

(boolean) Should the structure be prepended with WP_Rewrite::$front? Default is true.

ep_mask

(integer) Endpoint mask defining what endpoints are added to the structure. Default is EP_NONE.

paged

(boolean) Should archive pagination rules be added for the structure? Default is true.

feed

(boolean) Should feed rewrite rules be added for the structure? Default is true.

forcomments

(boolean) Should the feed rules be a query for a comments feed? Default is false.

walk_dirs

(boolean) Should the 'directories' making up the structure be walked over and rewrite rules built for each in turn? Default is true.

endpoints 

(boolean) Should endpoints be applied to the generated rewrite rules? Default is true.

Source File

add_permastruct() is located in wp-includes/rewrite.php

Related

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/