get_page_uri() – Function | Developer.WordPress.org

Builds the URI path for a page.

Description

Sub pages will be in the "directory" under the parent page post name.

Parameters

$pageWP_Post|object|intoptional: Page ID or WP_Post object. Default is global $post.

Return

string|false Page URI, false on error.

More Information

If the page has parents, those are prepended to the URI to provide a full path. For example, a third level page might return a URI like this:

top-level-page/sub-page/current-page

This function will return a “slug” style URI regardless of whether “pretty” Permalinks are configured.

Source

function get_page_uri( $page = 0 ) {
	if ( ! $page instanceof WP_Post ) {
		$page = get_post( $page );
	}

	if ( ! $page ) {
		return false;
	}

	$uri = $page->post_name;

	foreach ( $page->ancestors as $parent ) {
		$parent = get_post( $parent );
		if ( $parent && $parent->post_name ) {
			$uri = $parent->post_name . '/' . $uri;
		}
	}

	/**
	 * Filters the URI for a page.
	 *
	 * @since 4.4.0
	 *
	 * @param string  $uri  Page URI.
	 * @param WP_Post $page Page object.
	 */
	return apply_filters( 'get_page_uri', $uri, $page );
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘get_page_uri’, string $uri, WP_Post $page ): Filters the URI for a page.

Uses	Description
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.
get_post()`wp-includes/post.php`	Retrieves post data given a post ID or post object.

Used by	Description
get_sample_permalink()`wp-admin/includes/post.php`	Returns a sample permalink based on the post name.
get_post_permalink()`wp-includes/link-template.php`	Retrieves the permalink for a post of a custom post type.
_get_page_link()`wp-includes/link-template.php`	Retrieves the page permalink.
WP_Rewrite::page_uri_index()`wp-includes/class-wp-rewrite.php`	Retrieves all pages and attachments for pages URIs.

Changelog

Version	Description
4.6.0	The `$page` parameter was made optional.
1.5.0	Introduced.

User Contributed Notes

Skip to note 2 content

Codex 9 years ago

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
Example
```
$page_id = 5;
$uri = get_page_uri( $page_id );
echo '<a href="' . esc_url( $uri ) . '">' . esc_html__( "The Page", "textdomain" ) . '</a>';
```
Log in to add feedback

get_page_uri( WP_Post|object|int $page ): string|false

In this article