the_permalink

Translators: %s: login URL.

Description

apply_filters( 'the_permalink', (string) $get_permalink, (int|WP_Post) $post ); 

Parameters (2)

0. $get_permalink (string) => get_permalink( $post )
The permalink for the current post.
1. $post (int|WP_Post)
Post ID, WP_Post object, or 0. Default 0.

Usage

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

Defined (3)

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

/wp-includes/link-template.php  
  1. echo esc_url( apply_filters( 'the_permalink', get_permalink( $post ), $post ) ); 
/wp-includes/comment-template.php  
  1. wp_login_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) ) 
  1. wp_logout_url( apply_filters( 'the_permalink', get_permalink( $post_id ) ) )