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
Parameters
Return
Source
Related
- Uses
- Used By
Changelog
User Contributed Notes

Description

Respects page_on_front. Use this one.

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

Return

(string) The page permalink.

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 View on GitHub

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

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.

Changelog

Changelog
Version	Description
1.5.0	Introduced.

User Contributed Notes

Skip to note 1 content

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

Contributed by Drew Jaynes — 6 years ago
```
<a href="<?php echo esc_url( get_page_link( 40 ) ); ?>">
    <?php esc_html_e( 'Map', 'textdomain' ); ?>
</a>
```
Log in to add feedback
Skip to note 2 content

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

Contributed by Mohit Mishra — 2 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>
```
Log in to add feedback

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