Get Child Pages List In Wordpress

10th May 2010 - 3 minutes read time

It is possible to print out a list of pages in Wordpress, but these functions are designed to print from the root pages to a certain level. I often need to print out a list of pages that are children of the current page being looked at so I created the following function.

/**
 * Get a list of child pages.
 *
 * @param integer $id         The ID of the parent page.
 *
 * @return string The list of child pages.
 */
function getChildPagesList($id)
{
    // Get the child pages of the current page.
    $args = array(
                    'child_of' => $id,
                    'echo'     => 0,
                 );
    $pages = get_pages($args);

    // Build the page list
    $class = '';

    $option = '<ul>';

    foreach ($pages as $pagg) {
        if (is_page($pagg->ID)) {
            $class = ' class="on"';
        }
        $option .= '<li' . $class . '>';
        $option .= '<a href="' . get_page_link($pagg->ID) . '" title="' . $pagg->post_title . '">' . $pagg->post_title . '</a>';
        $option .= '</li>';
        $class = '';
    }

    $option .= '</ul>';

    // Return list
    return $option;
}

 

This function works by calling the get_pages() function in order to retrieve the pages that are children to this page. The echo argument is also used and given a 0 to make the function return the array of pages rather than just print them out. To use this function create some pages that have children and pick a page (in this instance page ID 29) you want to print out like this.

print getChildPagesList(29);

To print out the pages connected to the current post use the following:

echo getChildPagesList($post->ID);

 

PHP

Comments

Couldn't you use wp_list_pages with the 'child_of' parameter included?

So the equivalent examples would be:

wp_list_pages('child_of=29');

wp_list_pages('child_of='.$post->ID);

and you can also choose whether or not to print out the returned pages with the argument 'echo=1' or 'echo=0'.

Submitted by Rik on Sun, 06/13/2010 - 14:13

Permalink

You are quite right, wp_list_pages() would do the job just as well. I'm sure there was a very good reason that I created this function, although I'm not sure what it was now. :)

Philip Norton

Submitted by philipnorton42 on Sun, 06/13/2010 - 15:52

Permalink

Add new comment

The content of this field is kept private and will not be shown publicly.

Related Content

A Look At Flood Fill Algorithms In PHP

8th June 2025

If you have ever used a paint program then you might have used a flood fill algorithm. This is a mechanism by which an area of an image can be filled with a different colour and is normally depicted by a pain can pouring paint.

Read more

A Look At Benford's Law

11th May 2025

Benford's Law is an interesting heuristic in data analysis. It states that in any large collection of numbers that are created naturally, you should expect to see numbers starting with the number 1 about 30% of the time. The frequency distribution of numbers states that 2 should appear about 17% of the time, down to 9 being seen just 5% of the time.

Read more

Protecting A Page From Being Directly Accessed With PHP

27th April 2025

I was thinking recently about the number of ways in which I could restrict access to a page using PHP.

The obvious option is to create a user authentication system, but in some situations that is overkill for what is required. If you just want to prevent users from going directly to a certain page then there are a few options open to you.

Read more

Generating Colour Palettes From Images In PHP

4th August 2024

A common web design pattern is to incorporate an image into the design of the page. This creates a tighter integration with the image and the rest of the page.

The main issue in designing a page around the image is that the colours of the page must match the image. Otherwise this creates a dissonance between the image and the styles of the site.

Read more

Validating XML Files With XML Schema Definitions In PHP

21st July 2024

XML is a useful format for configuration, data storage, and transmitting data from one system to another. As a human readable format that can be easily read by machines it quickly gained favor in lots of different systems as a mechanism for data storage.

Read more