WordPress Developer Resources

apply_filters( ‘the_permalink’, string $permalink, int|WP_Post $post )

Filters the display of the permalink for the current post.

Parameters

$permalinkstring: The permalink for the current post.
$postint|WP_Post: Post ID, WP_Post object, or 0. Default 0.

More Information

the_permalink is a filter applied to the permalink URL for a post prior to printing by the function the_permalink().

Note: The output of the functions get_permalink() or get_the_permalink() is not filtered.

Source

echo esc_url( apply_filters( 'the_permalink', get_permalink( $post ), $post ) );

View all references View on Trac View on GitHub

Used by	Description
the_permalink()`wp-includes/link-template.php`	Displays the permalink for the current post.
comment_form()`wp-includes/comment-template.php`	Outputs a complete commenting form for use within a template.

Changelog

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

User Contributed Notes

Skip to note 2 content

Steven Lin 4 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
Example migrated from Codex:

Append the query string for the current page to permalink URLs (uses add_query_arg):
```
function append_query_string($url) {
    return add_query_arg($_GET, $url);
}
add_filter('the_permalink', 'append_query_string');
```
Log in to add feedback

You must log in before being able to contribute a note or feedback.