Say you have a custom taxonomy called “sport” and you wanted to inject “football” into the permalink of posts that have the “football” term assigned to it. How would you go about doing that? Well below is a helper class that will make it easy to accomplish exactly that.

As a reminder, here’s how you go about registering a custom taxonomy using the register_taxonomy() function:

[code language=”php”]add_action( ‘init’, ‘register_sport_taxonomy’ );

function register_sport_taxonomy() {
register_taxonomy( ‘sport’, ‘post’, array(
‘labels’ => array(
‘name’ => ‘Sports’,
),
‘hierarchical’ => true, // Makes for a better selection box on write screen
) );
}[/code]

And now, for my helper class:

(feel free to highlight and then copy/paste this code into your favorite text editor to make it easier to read)

[code language=”php”]/**
* A helper class for registering and handling a custom rewrite tag for a custom taxonomy.
*
* @version 1.1.0
*/
class Add_Taxonomy_To_Post_Permalinks {

/**
* Stores the taxonomy slug that this class will be handling. Don’t edit this.
*
* @since 1.0.0
* @var string
*/
public $taxonomy;

/**
* Stores the rewrite tag complete with percentage signs. Don’t edit this.
*
* @since 1.0.0
* @var string
*/
public $rewrite_tag;

/**
* Initializes the class by calling Add_Taxonomy_To_Post_Permalinks::register()
* as well as registering a filter that runs in get_permalink().
*
* @since 1.0.0
*
* @param string $taxonomy A taxonomy slug. Use the same one that you used with register_taxonomy().
* @return array $optional_args Optional configuration parameters. See Add_Taxonomy_To_Post_Permalinks::register().
*/
function __construct( $taxonomy, $optional_args = array() ) {
if ( ! $this->register( $taxonomy, $optional_args ) )
return;

// Normal posts
add_filter( ‘post_link’, array( &$this, ‘filter_post_link’ ), 10, 2 );

// Custom post types
add_filter( ‘post_type_link’, array( &$this, ‘filter_post_link’ ), 10, 2 );
}

/**
* Registers the rewrite tag using add_rewrite_tag().
*
* Can accept an array of optional parameters:
*
* * tagname: The rewrite tag to use (no percentage signs). Defaults to the taxonomy slug.
* * regex: What regex to use to validate the value of the tag. Defaults to anything but a forward slash.
*
* @since 1.0.0
*
* @param string $taxonomy A taxonomy slug. Use the same one that you used with register_taxonomy().
* @return array $optional_args Optional configuration parameters. See function description.
*/
public function register( $taxonomy, $optional_args = array() ) {
if ( ! taxonomy_exists( $taxonomy ) )
return false;

$this->taxonomy = $taxonomy;

$this->rewrite_tag = ( ! empty( $optional_args[‘tagname’] ) ) ? $optional_args[‘tagname’] : $this->taxonomy;
$this->rewrite_tag = ‘%’ . $this->rewrite_tag . ‘%’;

$rewrite_tag_regex = ( ! empty( $optional_args[‘regex’] ) ) ? $optional_args[‘regex’] : ‘([^/]+)’;

// See http://codex.wordpress.org/Rewrite_API/add_rewrite_tag
add_rewrite_tag( $this->rewrite_tag, $rewrite_tag_regex );

return true;
}

/**
* Filters a post permalink to replace the tag placeholder with the first
* used term from the taxonomy in question.
*
* @since 1.0.0
*
* @param string $permalink The existing permalink URL.
* @return object $post The post object that this permalink belongs to.
*/
public function filter_post_link( $permalink, $post ) {
// Abort early if the placeholder rewrite tag isn’t in the generated URL
if ( false === strpos( $permalink, $this->rewrite_tag ) )
return $permalink;

// Get the custom taxonomy terms in use by this post
$terms = get_the_terms( $post->ID, $this->taxonomy );

// If no terms are assigned to this post, use the taxonomy slug instead (can’t leave the placeholder there)
if ( empty( $terms ) ) {
$permalink = str_replace( $this->rewrite_tag, $this->taxonomy, $permalink );
}

// Replace the placeholder rewrite tag with the first term’s slug
else {
$first_term = array_shift( $terms );
$permalink = str_replace( $this->rewrite_tag, $first_term->slug, $permalink );
}

return $permalink;
}
}[/code]

To use the class, simply initiate a new instance of it and pass the taxonomy slug to it while doing so:

[code language=”php” highlight=”11,12″]add_action( ‘init’, ‘register_sport_taxonomy’ );

function register_sport_taxonomy() {
register_taxonomy( ‘sport’, ‘post’, array(
‘labels’ => array(
‘name’ => ‘Sports’,
),
‘hierarchical’ => true, // Makes for a better selection box on write screen
) );

$sport_taxonomy_permalinks
= new Add_Taxonomy_To_Post_Permalinks( ‘sport’ );
}[/code]

Then go to Settings → Permalinks and add %taxonomy% to your structure, such as /%sport%/%year%/%monthnum%/%day%/%postname%/. It will then be replaced by the first term (sorted by term ID) of your custom taxonomy.

More complicated solutions are of course possible, such as picking which of multiple terms you want injected into the URL or multiple terms in the URL, but my class should give you a good starting point to work off of. 🙂