the_permalink │ filter-hook │ WP 1.5.0

Filters the display of the permalink for the current post.

Usage

add_filter( 'the_permalink', 'wp_kama_the_permalink_filter', 10, 2 );

/**
 * Function for `the_permalink` filter-hook.
 * 
 * @param string      $permalink The permalink for the current post.
 * @param int|WP_Post $post      Post ID, WP_Post object, or 0.
 *
 * @return string
 */
function wp_kama_the_permalink_filter( $permalink, $post ){

	// filter...
	return $permalink;
}

$permalink(string)

The permalink for the current post.

$post(int|WP_Post)

Post ID, WP_Post object, or 0.

Changelog

Where the hook is called

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

wp_login_url( apply_filters( 'the_permalink', get_permalink( $post_id ), $post_id ) )

wp_logout_url( apply_filters( 'the_permalink', get_permalink( $post_id ), $post_id ) )

Where the hook is used in WordPress