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( int|WP_Post $post = false, bool $leavename = false, bool $sample = false ): string
Retrieves the page permalink.
Contents
Description
Ignores page_on_front. Internal use only.
Parameters
-
$postint|WP_Post Optional -
Post ID or object. Default uses the global
$post.Default:
false -
$leavenamebool Optional -
Whether to keep the page name.
Default:
false -
$samplebool Optional -
Whether it should be treated as a sample permalink.
Default:
false
Return
string The page permalink.
Source
File: wp-includes/link-template.php.
View all references
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 );
}
Hooks
-
apply_filters( '_get_page_link',
string $link ,int $post_id ) -
Filters the permalink for a non-page_on_front page.
Changelog
| Version | Description |
|---|---|
| 2.1.0 | Introduced. |