Summery Summery

Retrieves the permalink for the current page or page ID.

Syntax Syntax

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

Description Description

Respects page_on_front. Use this one.

Parameters Parameters


(Optional) Post ID or object. Default uses the global $post.

Default value: false


(Optional) Whether to keep the page name.

Default value: false


(Optional) Whether it should be treated as a sample permalink.

Default value: false

Return Return

(string) The page permalink.

Source Source

File: wp-includes/link-template.php

	$post = get_post( $post );

	if ( 'page' === get_option( 'show_on_front' ) && 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 );


Changelog Changelog

Version Description
1.5.0 Introduced.


Leave a Reply