wppaste
WordPress

apply_filters( 'the_category_list', \WP_Term[] $categories, int|false $post_id )

Since
4.4.0
Filters the categories before building the category list.

Compatibility

WordPress
since 4.4.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Parameters

$categories\WP_Term[]
An array of the post's categories.
$post_idint|false
ID of the post to retrieve categories for.
When false, defaults to the current post in the loop.

Where this hook fires · 1

  • wp-includes/category-template.php:158get_the_category_list()

Source code

View on Trac View on GitHub 

<?php	 * @since 4.4.0	 *	 * @param WP_Term[] $categories An array of the post's categories.	 * @param int|false $post_id    ID of the post to retrieve categories for.	 *                              When `false`, defaults to the current post in the loop.	 */	$categories = apply_filters( 'the_category_list', get_the_category( $post_id ), $post_id ); 	if ( empty( $categories ) ) {		/** This filter is documented in wp-includes/category-template.php */		return apply_filters( 'the_category', __( 'Uncategorized' ), $separator, $parents );	}

Changelog

Introduced in 4.4.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.