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.
  1. $output = apply_filters( 'wp_list_pages', $output, $r, $pages ); 
  2.  
  3. if ( !empty( $output ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the wp_list_pages callback 
  2. function filter_wp_list_pages( $output, $r, $pages ) { 
  3. // make filter magic happen here... 
  4. return $output
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'wp_list_pages', 'filter_wp_list_pages', 10, 3 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'wp_list_pages', 'filter_wp_list_pages', 10, 3 ); 

Defined (1)

The filter is defined in the following location(s).

/wp-includes/post-template.php  
  1. $html = apply_filters( 'wp_list_pages', $output, $r, $pages );