WordPress at a glance
filter is not described

the_permalink filter-hook . WP 1.5.0

Filters the display of the permalink for the current post.

Usage

add_filter( 'the_permalink', 'filter_function_name_8223', 10, 2 );
function filter_function_name_8223( $permalink, $post ){
	// filter...

	return $permalink;
}
$permalink(string)
The permalink for the current post.
$post(int/WP_Post)
Post ID, WP_Post object, or 0.

Notes

  • Since 4.4.0 Added the $post parameter.

Where the hook is called

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

Where the hook is used (in WP core)

Does not used.