get_children()

You are here:

get_children( mixed $args = string $output = OBJECT )

Description Description

Normally, without any enhancements, the children would apply to pages. In the context of the inner workings of WordPress, pages, posts, and attachments share the same table, so therefore the functionality could apply to any one of them. It is then noted that while this function does not work on posts, it does not mean that it won’t work on posts. It is recommended that you know what context you wish to retrieve the children of.

Attachments may also be made the child of a post, so if that is an accurate statement (which needs to be verified), it would then be possible to get all of the attachments for a post. Attachments have since changed since version 2.5, so this is most likely inaccurate, but serves generally as an example of what is possible.

The arguments listed as defaults are for this function and also of the get_posts() function. The arguments are combined with the get_children defaults and are then passed to the get_posts() function, which accepts additional arguments. You can replace the defaults in this function, listed below and the additional arguments listed in the get_posts() function.

The ‘post_parent’ is the most important argument and important attention needs to be paid to the $args parameter. If you pass either an object or an integer (number), then just the ‘post_parent’ is grabbed and everything else is lost. If you don’t specify any arguments, then it is assumed that you are in The Loop and the post parent will be grabbed for from the current post.

The ‘post_parent’ argument is the ID to get the children. The ‘numberposts’ is the amount of posts to retrieve that has a default of ‘-1’, which is used to get all of the posts. Giving a number higher than 0 will only retrieve that amount of posts.

The ‘post_type’ and ‘post_status’ arguments can be used to choose what criteria of posts to retrieve. The ‘post_type’ can be anything, but WordPress post types are ‘post’, ‘pages’, and ‘attachments’. The ‘post_status’ argument will accept any post status within the write administration panels.

See also See also

  • get_posts()

Top ↑

Parameters Parameters

$args

(mixed) (Optional) User defined arguments for replacing the defaults.

Default value: ”

$output

(string) (Optional) The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to a WP_Post object, an associative array, or a numeric array, respectively.

Default value: OBJECT


Top ↑

Return Return

(WP_Post[]|int[]) Array of post objects or post IDs.


Top ↑

Source Source

File: wp-includes/post.php

641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
function get_children( $args = '', $output = OBJECT ) {
    $kids = array();
    if ( empty( $args ) ) {
        if ( isset( $GLOBALS['post'] ) ) {
            $args = array( 'post_parent' => (int) $GLOBALS['post']->post_parent );
        } else {
            return $kids;
        }
    } elseif ( is_object( $args ) ) {
        $args = array( 'post_parent' => (int) $args->post_parent );
    } elseif ( is_numeric( $args ) ) {
        $args = array( 'post_parent' => (int) $args );
    }
 
    $defaults = array(
        'numberposts' => -1,
        'post_type'   => 'any',
        'post_status' => 'any',
        'post_parent' => 0,
    );
 
    $parsed_args = wp_parse_args( $args, $defaults );
 
    $children = get_posts( $parsed_args );
 
    if ( ! $children ) {
        return $kids;
    }
 
    if ( ! empty( $parsed_args['fields'] ) ) {
        return $children;
    }
 
    update_post_cache( $children );
 
    foreach ( $children as $key => $child ) {
        $kids[ $child->ID ] = $children[ $key ];
    }
 
    if ( OBJECT == $output ) {
        return $kids;
    } elseif ( ARRAY_A == $output ) {
        $weeuns = array();
        foreach ( (array) $kids as $kid ) {
            $weeuns[ $kid->ID ] = get_object_vars( $kids[ $kid->ID ] );
        }
        return $weeuns;
    } elseif ( ARRAY_N == $output ) {
        $babes = array();
        foreach ( (array) $kids as $kid ) {
            $babes[ $kid->ID ] = array_values( get_object_vars( $kids[ $kid->ID ] ) );
        }
        return $babes;
    } else {
        return $kids;
    }
}


Top ↑

Changelog Changelog

Changelog
VersionDescription
2.0.0Introduced.

Top ↑

Was this article helpful?
Dislike 0
Views: 2

Cart

Log in

Create an Account
Back to Top