get_page_link() – Function | Developer.WordPress.org

Retrieves the permalink for the current page or page ID.

Description

Respects page_on_front. Use this one.

Parameters

$postint|WP_Postoptional: Post ID or object. Default uses the global $post.
Default:false
$leavenamebooloptional: Whether to keep the page name.
Default:false
$samplebooloptional: Whether it should be treated as a sample permalink.

Default:false

Return

string The page permalink.

Source

function get_page_link( $post = false, $leavename = false, $sample = false ) {
	$post = get_post( $post );

	if ( 'page' === get_option( 'show_on_front' ) && (int) get_option( 'page_on_front' ) === $post->ID ) {
		$link = home_url( '/' );
	} else {
		$link = _get_page_link( $post, $leavename, $sample );
	}

	/**
	 * Filters the permalink for a page.
	 *
	 * @since 1.5.0
	 *
	 * @param string $link    The page's permalink.
	 * @param int    $post_id The ID of the page.
	 * @param bool   $sample  Is it a sample permalink.
	 */
	return apply_filters( 'page_link', $link, $post->ID, $sample );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘page_link’, string $link, int $post_id, bool $sample ): Filters the permalink for a page.

Uses	Description
_get_page_link()`wp-includes/link-template.php`	Retrieves the page permalink.
home_url()`wp-includes/link-template.php`	Retrieves the URL for the current site where the front end is accessible.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.
get_option()`wp-includes/option.php`	Retrieves an option value based on an option name.
get_post()`wp-includes/post.php`	Retrieves post data given a post ID or post object.

Show 3 more Show less

Used by	Description
get_permalink()`wp-includes/link-template.php`	Retrieves the full permalink for the current post or post ID.

Changelog

Version	Description
1.5.0	Introduced.

User Contributed Notes

Skip to note 3 content

Drew Jaynes 8 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

[html]
<a href="<?php echo esc_url( get_page_link( 40 ) ); ?>">
<?php esc_html_e( ‘Map’, ‘textdomain’ ); ?>
</a>
[/html]

Log in to add feedback

Mohit Mishra 4 years ago

// get blog page id.
$page_for_posts = get_option( 'page_for_posts' );
?>
<a href="<?php echo esc_attr( esc_url( get_page_link( $page_for_posts ) ) ) ?>"><?php esc_html_e( 'Blog Page', 'textdomain' ) ?></a>

get_page_link( int|WP_Post $post = false, bool $leavename = false, bool $sample = false ): string

In this article

Description

Parameters

Return

Source

Hooks

Changelog

User Contributed Notes