wp_list_pages

Filters the HTML output of the pages to list.

Description

apply_filters( 'wp_list_pages', (string) $output, (array) $r, (array) $pages ); 

Parameters (3)

0. $output (string)

HTML output of the pages list.

1. $r (array)

An array of page-listing arguments.

2. $pages (array)

List of WP_Post objects returned by get_pages(…)

Usage

To run the hook, copy the example below.

$output = apply_filters( 'wp_list_pages', $output, $r, $pages ); 
                         
if ( !empty( $output ) ) { 
                         
   // everything has led up to this point... 
                         
} 
  

The following example is for adding a hook callback.

// define the wp_list_pages callback 
function filter_wp_list_pages( $output, $r, $pages ) { 
    // make filter magic happen here... 
    return $output; 
}; 
         
// add the filter 
add_filter( 'wp_list_pages', 'filter_wp_list_pages', 10, 3 ); 

To remove a hook callback, use the example below.

// remove the filter 
remove_filter( 'wp_list_pages', 'filter_wp_list_pages', 10, 3 );