WP_Rewrite::page_uri_index(): array

Description

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Return value

array

Array of page URIs as first element and attachment URIs as second element.

Performance profile

How much work a call to WP_Rewrite::page_uri_index() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via ->get_results().

Scaling

Scales with input

The body loops, so the work grows with how much data it finds.

Instructions

15–27

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 63.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• sqldatabase query->get_results()called directly
• querycontent queryget_post()one call below WP_Rewrite::page_uri_index()
• hookthird-party callbacksapply_filters()one call below WP_Rewrite::page_uri_index()

Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 2 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Rewrite::page_uri_index() can have, taken from its control-flow graph on PHP 8.5.

Uses · 2

• get_page_hierarchy()Orders the pages with children under parents in a flat list.
• get_page_uri()Builds the URI path for a page.

Source code

View on Trac ↗View on GitHub ↗

427	public function page_uri_index() {428		global $wpdb;429 430		// Get pages in order of hierarchy, i.e. children after parents.431		$pages = $wpdb->get_results( "SELECT ID, post_name, post_parent FROM $wpdb->posts WHERE post_type = 'page' AND post_status != 'auto-draft'" );432		$posts = get_page_hierarchy( $pages );433 434		// If we have no pages get out quick.435		if ( ! $posts ) {436			return array( array(), array() );437		}438 439		// Now reverse it, because we need parents after children for rewrite rules to work properly.440		$posts = array_reverse( $posts, true );441 442		$page_uris            = array();443		$page_attachment_uris = array();444 445		foreach ( $posts as $id => $post ) {446			// URL => page name.447			$uri         = get_page_uri( $id );448			$attachments = $wpdb->get_results( $wpdb->prepare( "SELECT ID, post_name, post_parent FROM $wpdb->posts WHERE post_type = 'attachment' AND post_parent = %d", $id ) );449			if ( ! empty( $attachments ) ) {450				foreach ( $attachments as $attachment ) {451					$attach_uri                          = get_page_uri( $attachment->ID );452					$page_attachment_uris[ $attach_uri ] = $attachment->ID;453				}454			}455 456			$page_uris[ $uri ] = $id;457		}458 459		return array( $page_uris, $page_attachment_uris );460	}

Changelog

Introduced in 2.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 7.1.0 tag, from src/wp-includes/class-wp-rewrite.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.