add_permastruct( string $name, string $struct, array $args = array() )
Adds a permalink structure.
Contents
Description
See also
Parameters
-
$name
string Required -
Name for permalink structure.
-
$struct
string Required -
Permalink structure.
-
$args
array Optional -
Arguments for building the rules from the permalink structure, see WP_Rewrite::add_permastruct() for full details.
More Arguments from WP_Rewrite::add_permastruct( ... $args )
Arguments for building rewrite rules based on the permalink structure.
with_front
boolWhether the structure should be prepended withWP_Rewrite::$front
.
Default true.ep_mask
intThe endpoint mask defining which endpoints are added to the structure.
Accepts a mask of:
EP_ALL
EP_NONE
EP_ALL_ARCHIVES
EP_ATTACHMENT
EP_AUTHORS
EP_CATEGORIES
EP_COMMENTS
EP_DATE
EP_DAY
EP_MONTH
EP_PAGES
EP_PERMALINK
EP_ROOT
EP_SEARCH
EP_TAGS
EP_YEAR
DefaultEP_NONE
.
paged
boolWhether archive pagination rules should be added for the structure.
Default true.feed
boolWhether feed rewrite rules should be added for the structure. Default true.forcomments
boolWhether the feed rules should be a query for a comments feed. Default false.walk_dirs
boolWhether the'directories'
making up the structure should be walked over and rewrite rules built for each in-turn. Default true.endpoints
boolWhether endpoints should be applied to the generated rules. Default true.
Default:
array()
Source
File: wp-includes/rewrite.php
.
View all references
function add_permastruct( $name, $struct, $args = array() ) {
global $wp_rewrite;
// Back-compat for the old parameters: $with_front and $ep_mask.
if ( ! is_array( $args ) ) {
$args = array( 'with_front' => $args );
}
if ( func_num_args() === 4 ) {
$args['ep_mask'] = func_get_arg( 3 );
}
$wp_rewrite->add_permastruct( $name, $struct, $args );
}
Changelog
Version | Description |
---|---|
3.0.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
You can change rules to rewrite your type of posting as well as change your structure. Imagine that your permalink structure is like:
/locations/%k7_locations%
you can switch to
/test/%message%
output:
To add a custom URL-/permalink-structure, this function must be called on every request (not only once). I usually do this in the ‘init’ hook.
However, the related function
flush_rewrite_rules()
should only be called when the permalink structure changes.Sample: