Adds a permalink structure.

• WP_Rewrite::add_permastruct()

$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_frontbool
  Whether the structure should be prepended with WP_Rewrite::$front.
  Default true.
• ep_maskint
  The 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 Default EP_NONE.
• pagedbool
  Whether archive pagination rules should be added for the structure.
  Default true.
• feedbool
  Whether feed rewrite rules should be added for the structure. Default true.
• forcommentsbool
  Whether the feed rules should be a query for a comments feed. Default false.
• walk_dirsbool
  Whether the 'directories' making up the structure should be walked over and rewrite rules built for each in-turn. Default true.
• endpointsbool
  Whether endpoints should be applied to the generated rules. Default true.

Default: array()

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 );
}