Alert: This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.
_get_page_link() WordPress Function
The get_page_link() function is used to retrieve the permalink for a page. This function is useful when you need to create a link to a page but don't have the page ID.
_get_page_link( int|WP_Post $post = false, bool $leavename = false, bool $sample = false ) #
Retrieves the page permalink.
Description
Ignores page_on_front. Internal use only.
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 ) { global $wp_rewrite; $post = get_post( $post ); $force_plain_link = wp_force_plain_post_permalink( $post ); $link = $wp_rewrite->get_page_permastruct(); if ( ! empty( $link ) && ( ( isset( $post->post_status ) && ! $force_plain_link ) || $sample ) ) { if ( ! $leavename ) { $link = str_replace( '%pagename%', get_page_uri( $post ), $link ); } $link = home_url( $link ); $link = user_trailingslashit( $link, 'page' ); } else { $link = home_url( '?page_id=' . $post->ID ); } /** * Filters the permalink for a non-page_on_front page. * * @since 2.1.0 * * @param string $link The page's permalink. * @param int $post_id The ID of the page. */ return apply_filters( '_get_page_link', $link, $post->ID ); }
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
Version | Description |
---|---|
2.1.0 | Introduced. |