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

Description

Parameters

$postint|WP_Postoptional

Post ID or object. Default uses the global $post.Default: false

$leavenamebooloptional

Whether to keep the page name. Default false.Default: false

$samplebooloptional

Whether it should be treated as a sample permalink. Default false.Default: false

Return

string

The page permalink.

Hooks fired · 1

One hook fires while get_page_link() runs, in this order:

1. 1
   apply_filters( page_link )filterline 409 (+18 into the body)

   Filters the permalink for a page.

Uses · 5

• get_post()Retrieves post data given a post ID or post object.
• get_option()Retrieves an option value based on an option name.
• home_url()Retrieves the URL for the current site where the front end is accessible.
• _get_page_link()Retrieves the page permalink.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 1

• get_permalink()Retrieves the full permalink for the current post or post ID.

Source

View on Trac ↗View on GitHub ↗

391function get_page_link( $post = false, $leavename = false, $sample = false ) {392	$post = get_post( $post );393 394	if ( 'page' === get_option( 'show_on_front' ) && (int) get_option( 'page_on_front' ) === $post->ID ) {395		$link = home_url( '/' );396	} else {397		$link = _get_page_link( $post, $leavename, $sample );398	}399 400	/**401	 * Filters the permalink for a page.402	 *403	 * @since 1.5.0404	 *405	 * @param string $link    The page's permalink.406	 * @param int    $post_id The ID of the page.407	 * @param bool   $sample  Is it a sample permalink.408	 */409	return apply_filters( 'page_link', $link, $post->ID, $sample );410}

History

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/link-template.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.