post_type_link

Filters the permalink for a post of a custom post type.

Description

apply_filters( 'post_type_link', (string) $post_link, (WP_Post) $post, (string) $leavename, (bool) $sample ); 

Parameters (4)

0. $post_link (string)
The post's permalink.
1. $post (WP_Post)
The post in question.
2. $leavename (string)
Whether to keep the post name.
3. $sample (bool)
Is it a sample permalink.

Usage

To run the hook, copy the example below.
  1. $post_link = apply_filters( 'post_type_link', $post_link, $post, $leavename, $sample ); 
  2.  
  3. if ( !empty( $post_link ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the post_type_link callback 
  2. function filter_post_type_link( $post_link, $post, $leavename, $sample ) { 
  3. // make filter magic happen here... 
  4. return $post_link
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'post_type_link', 'filter_post_type_link', 10, 4 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'post_type_link', 'filter_post_type_link', 10, 4 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/link-template.php  
  1. return apply_filters( 'post_type_link', $post_link, $post, $leavename, $sample );