the_category_list

Filters the categories before building the category list.

Description

apply_filters( 'the_category_list', (array) $get_the_category, (int|bool) $post_id ); 

Parameters (2)

0. $get_the_category (array) => get_the_category( $post_id )
An array of the post's categories.
1. $post_id (int|bool)
ID of the post we're retrieving categories for. When false,, we assume the current post in the loop.

Usage

To run the hook, copy the example below.
  1. $get_the_category = apply_filters( 'the_category_list', $get_the_category, $post_id ); 
  2.  
  3. if ( !empty( $get_the_category ) ) { 
  4.  
  5. // everything has led up to this point... 
  6.  
  7.  
The following example is for adding a hook callback.
  1. // define the the_category_list callback 
  2. function filter_the_category_list( $get_the_category, $post_id ) { 
  3. // make filter magic happen here... 
  4. return $get_the_category
  5. }; 
  6.  
  7. // add the filter 
  8. add_filter( 'the_category_list', 'filter_the_category_list', 10, 2 ); 
To remove a hook callback, use the example below.
  1. // remove the filter 
  2. remove_filter( 'the_category_list', 'filter_the_category_list', 10, 2 ); 

Defined (1)

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

/wp-includes/category-template.php  
  1. $categories = apply_filters( 'the_category_list', get_the_category( $post_id ), $post_id );