wp_list_bookmarks

Filters the bookmarks list before it is echoed or returned.

Description

apply_filters( 'wp_list_bookmarks', (string) $output ); 

Parameters (1)

0. $output (string)
The HTML list of bookmarks.

Usage

To run the hook, copy the example below.
  1. $output = apply_filters( 'wp_list_bookmarks', $output ); 
  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_bookmarks callback 
  2. function filter_wp_list_bookmarks( $output ) { 
  3. // make filter magic happen here... 
  4. return $output
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'wp_list_bookmarks', 'filter_wp_list_bookmarks', 10, 1 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'wp_list_bookmarks', 'filter_wp_list_bookmarks', 10, 1 ); 

Defined (1)

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

/wp-includes/bookmark-template.php  
  1. $html = apply_filters( 'wp_list_bookmarks', $output );