WordPress.org

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

Filters the display of the permalink for the current post.

Contents

Parameters
More Information
Source
Related
- Used By
Changelog
User Contributed Notes

Parameters Parameters

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

More Information 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 Source

File: wp-includes/link-template.php

Used By Used By

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

Changelog Changelog

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

User Contributed Notes User Contributed Notes

Skip to note 1 content

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

Contributed by stevenlinx — 4 months ago
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.