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

Retrieves the permalink for the current page or page ID.

Contents

Description Description

Respects page_on_front. Use this one.

Top ↑

Parameters Parameters

$post

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

Default value: false

$leavename

(bool) (Optional) Whether to keep the page name.

Default value: false

$sample

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

Default value: false

Top ↑

Return Return

(string) The page permalink.

Top ↑

Source Source

File: wp-includes/link-template.php 

function get_page_link( $post = false, $leavename = false, $sample = false ) {
	$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 );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/link-template.php: home_url()

Retrieves the URL for the current site where the front end is accessible.
wp-includes/link-template.php: _get_page_link()

Retrieves the page permalink.
wp-includes/link-template.php: page_link

Filters the permalink for a page.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.
wp-includes/post.php: get_post()

Retrieves post data given a post ID or post object.
Show 1 more use Hide more uses

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/link-template.php: get_permalink()

Retrieves the full permalink for the current post or post ID.

Top ↑

Changelog Changelog

Changelog
Version Description
1.5.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.