the_permalink() – Function | Developer.WordPress.org

Displays the permalink for the current post.

Parameters

$postint|WP_Postoptional: Post ID or post object. Default is the global $post.

This tag must be within The Loop, and is generally used to display the permalink for each post, when the posts are being displayed. Since this template tag is limited to displaying the permalink for the post that is being processed, you cannot use it to display the permalink to an arbitrary post on your weblog. Refer to get_permalink() if you want to get the permalink for a post, given its unique post id.

Source

function the_permalink( $post = 0 ) {
	/**
	 * Filters the display of the permalink for the current post.
	 *
	 * @since 1.5.0
	 * @since 4.4.0 Added the `$post` parameter.
	 *
	 * @param string      $permalink The permalink for the current post.
	 * @param int|WP_Post $post      Post ID, WP_Post object, or 0. Default 0.
	 */
	echo esc_url( apply_filters( 'the_permalink', get_permalink( $post ), $post ) );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘the_permalink’, string $permalink, int|WP_Post $post ): Filters the display of the permalink for the current post.

Uses	Description
esc_url()`wp-includes/formatting.php`	Checks and cleans a URL.
get_permalink()`wp-includes/link-template.php`	Retrieves the full permalink for the current post or post ID.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.

Show 1 more Show less

Used by	Description
print_embed_sharing_dialog()`wp-includes/embed.php`	Prints the necessary markup for the embed sharing dialog.
permalink_link()`wp-includes/deprecated.php`	Print the permalink of the current post in the loop.
WP_Widget_Recent_Posts::widget()`wp-includes/widgets/class-wp-widget-recent-posts.php`	Outputs the content for the current Recent Posts widget instance.
trackback_rdf()`wp-includes/comment-template.php`	Generates and displays the RDF for the trackback information of current post.

Changelog

Version	Description
4.4.0	Added the `$post` parameter.
1.2.0	Introduced.

User Contributed Notes

Skip to note 4 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 7You must log in to vote on the helpfulness of this note
Used as Link With Title Tag
Creates a link for the permalink, with the post’s title as the link text. This is a common way to put the post’s title.
```
<a href="<?php the_permalink(); ?>" title="<?php the_title_attribute(); ?>"><?php the_title(); ?></a>
```
Log in to add feedback
Skip to note 5 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note
As Link With Text
You can use whatever text you like as the link text, in this case, “permalink”.
```
<a href="<?php the_permalink(); ?>">permalink</a>
```
Log in to add feedback
Skip to note 6 content

Codex 10 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note
Display Post URL as Text
Displays the URL to the post, without creating a link:
```
This address for this post is: <?php the_permalink(); ?>
```
Log in to add feedback

the_permalink( int|WP_Post $post )

In this article

Parameters

More Information

Source

Hooks

Changelog

User Contributed Notes

the_permalink( int|WP_Post $post )

In this article

Parameters

More Information

Source

Hooks

Related

Changelog

User Contributed Notes