post_link

Filters the permalink for a post.

Description

apply_filters( 'post_link', (string) $permalink, (WP_Post) $post, (string) $leavename ); 

Only applies to posts with post_type of post..

Parameters (3)

0. $permalink (string)

The post's permalink.

1. $post (WP_Post)

The post in question.

2. $leavename (string)

Whether to keep the post name.

Usage

To run the hook, copy the example below.

$permalink = apply_filters( 'post_link', $permalink, $post, $leavename ); 
                         
if ( !empty( $permalink ) ) { 
                         
   // everything has led up to this point... 
                         
} 
  

The following example is for adding a hook callback.

// define the post_link callback 
function filter_post_link( $permalink, $post, $leavename ) { 
    // make filter magic happen here... 
    return $permalink; 
}; 
         
// add the filter 
add_filter( 'post_link', 'filter_post_link', 10, 3 ); 

To remove a hook callback, use the example below.

// remove the filter 
remove_filter( 'post_link', 'filter_post_link', 10, 3 );