add_permastruct( string $name, string $struct, array $args = array() )

User Contributed Notes

1. Skip to note 3 content

   Marcio Zebedeu 6 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

   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%

   global $wp_rewrite;
   $args = array(
       'with_front' => true,
       'ep_mask' => 3,
       'paged' => 1,
       'feed' => 1,
       'forcomments' => 0,
       'walk_dirs' => 1,
       'endpoints' => 1
   );
   add_permastruct( 'locations', 'test/%message/', $args);

   output:

   Array
   (
       [with_front] => 1
       [ep_mask] => 3
       [paged] => 1
       [feed] => 1
       [forcomments] => 0
       [walk_dirs] => 1
       [endpoints] => 1
       [struct] => /test/%message/%
   )
2. Skip to note 4 content

   Philipp Stracker 3 years ago

   You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

   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:

   add_action( 'init', 'wpdocs_custom_permalink' );
   function wpdocs_custom_permalinks() {
     // Register the permastruct and rewrite tag on every page load:
     add_permastruct( 'legal', 'legal/%my_slug%', [ 'ep_mask' => EP_PERMALINK ] );
     add_rewrite_tag( '%my_slug%', '([^/]+)', "post_type=page&name=" );
   
     // Only flush rewrite rules, if your permalink changed (e.g. on plugin activation):
     if ( $has_changed ) {
       flush_rewrite_rules();
     }
   }