the_permalink

Displays the permalink for the current post.

Description

the_permalink( (int) $post = 0 ); 

Parameters (1)

0. $post — Optional. (int)
Post ID or post object. Default is the global $post..

Usage

  1. if ( !function_exists( 'the_permalink' ) ) { 
  2.     require_once ABSPATH . WPINC . '/link-template.php'; 
  3. } 
  4.   
  5. // Optional. Post ID or post object. Default is the global `$post`. 
  6. $post = -1; 
  7.   
  8. // NOTICE! Understand what this does before running. 
  9. $result = the_permalink($post); 
  10.     

Defined (1)

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

/wp-includes/link-template.php  
  1. function the_permalink( $post = 0 ) { 
  2.     /** 
  3.      * Filters the display of the permalink for the current post. 
  4.      * 
  5.      * @since 1.5.0 
  6.      * @since 4.4.0 Added the `$post` parameter. 
  7.      * 
  8.      * @param string      $permalink The permalink for the current post. 
  9.      * @param int|WP_Post $post      Post ID, WP_Post object, or 0. Default 0. 
  10.      */ 
  11.     echo esc_url( apply_filters( 'the_permalink', get_permalink( $post ), $post ) ); 
  12. }