get_page_children( int $page_id, array $pages )
Identify descendants of a given page ID in a list of page objects.
Description Description
Descendants are identified from the $pages array passed to the function. No database queries are performed.
Parameters Parameters
- $page_id
-
(int) (Required) Page ID.
- $pages
-
(array) (Required) List of page objects from which descendants should be identified.
Return Return
(array) List of page children.
Source Source
File: wp-includes/post.php
function get_page_children( $page_id, $pages ) {
// Build a hash of ID -> children.
$children = array();
foreach ( (array) $pages as $page ) {
$children[ intval( $page->post_parent ) ][] = $page;
}
$page_list = array();
// Start the search by looking at immediate children.
if ( isset( $children[ $page_id ] ) ) {
// Always start at the end of the stack in order to preserve original `$pages` order.
$to_look = array_reverse( $children[ $page_id ] );
while ( $to_look ) {
$p = array_pop( $to_look );
$page_list[] = $p;
if ( isset( $children[ $p->ID ] ) ) {
foreach ( array_reverse( $children[ $p->ID ] ) as $child ) {
// Append to the `$to_look` stack to descend the tree.
$to_look[] = $child;
}
}
}
}
return $page_list;
}
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 1.5.1 | Introduced. |
User Contributed Notes User Contributed Notes
You must log in before being able to contribute a note or feedback.
In one of my Hierarchical Custom Post Type (
locations) I did @bhlarsen’s method, and in some extent it’s returning false children. So I did it my way:ID; //Instead of calling and passing query parameter differently, we're doing it exclusively $all_locations = get_pages( array( 'post_type' => 'locations', //here's my CPT 'post_status' => array( 'publish', 'pending' ) //my custom choice ) ); //Using the function $inherited_locations = get_page_children( $location_parent_id, $all_locations ); // echo what we get back from WP to the browser (@bhlarsen's part :) ) echo '' . print_r( $inherited_locations, true ) . ''; ?>Expand full source codeCollapse full source code
It’s giving me the correct children.
Examples
<?php // Set up the objects needed $my_wp_query = new WP_Query(); $all_wp_pages = $my_wp_query->query(array('post_type' => 'page')); // Get the page as an Object $portfolio = get_page_by_title('Portfolio'); // Filter through all pages and find Portfolio's children $portfolio_children = get_page_children( $portfolio->ID, $all_wp_pages ); // echo what we get back from WP to the browser echo '<pre>' . print_r( $portfolio_children, true ) . '</pre>'; ?>Expand full source codeCollapse full source code