get_page_hierarchy() WP 1.0

Order the pages with children under parents in a flat list.

It uses auxiliary structure to hold parent-children relationships and runs in O(N) complexity

No Hooks.

Return

Array. A list arranged by hierarchy. Children immediately follow their parents.

Usage

get_page_hierarchy( $pages, $page_id );

$pages(array) (required) (passed by reference — &)

Posts array (passed by reference).

$page_id(int)

Parent page ID.
Default: 0

Changelog

Code of get page hierarchy: wp-includes/post.php ^{WP 5.2.2}

<?php
function get_page_hierarchy( &$pages, $page_id = 0 ) {
	if ( empty( $pages ) ) {
		return array();
	}

	$children = array();
	foreach ( (array) $pages as $p ) {
		$parent_id                = intval( $p->post_parent );
		$children[ $parent_id ][] = $p;
	}

	$result = array();
	_page_traverse_name( $page_id, $children, $result );

	return $result;
}

Related Functions

From category: Helper Functions