_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( _get_page_link )filterline 456 (+28 into the body)

   Filters the permalink for a non-page_on_front page.

Uses · 6

• get_post()Retrieves post data given a post ID or post object.
• wp_force_plain_post_permalink()Determine whether post should always use a plain permalink structure.
• get_page_uri()Builds the URI path for a page.
• home_url()Retrieves the URL for the current site where the front end is accessible.
• user_trailingslashit()Retrieves a trailing-slashed string if the site is set for adding trailing slashes.
• apply_filters()Calls the callback functions that have been added to a filter hook.

Used by · 3

• get_attachment_link()Retrieves the permalink for an attachment.
• get_page_link()Retrieves the permalink for the current page or page ID.
• get_post_comments_feed_link()Retrieves the permalink for the post comments feed.

Source

View on Trac ↗View on GitHub ↗

428function _get_page_link( $post = false, $leavename = false, $sample = false ) {429	global $wp_rewrite;430 431	$post = get_post( $post );432 433	$force_plain_link = wp_force_plain_post_permalink( $post );434 435	$link = $wp_rewrite->get_page_permastruct();436 437	if ( ! empty( $link ) && ( ( isset( $post->post_status ) && ! $force_plain_link ) || $sample ) ) {438		if ( ! $leavename ) {439			$link = str_replace( '%pagename%', get_page_uri( $post ), $link );440		}441 442		$link = home_url( $link );443		$link = user_trailingslashit( $link, 'page' );444	} else {445		$link = home_url( '?page_id=' . $post->ID );446	}447 448	/**449	 * Filters the permalink for a non-page_on_front page.450	 *451	 * @since 2.1.0452	 *453	 * @param string $link    The page's permalink.454	 * @param int    $post_id The ID of the page.455	 */456	return apply_filters( '_get_page_link', $link, $post->ID );457}

History

Introduced in 2.1.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.