Changeset 34625

Timestamp:

09/27/2015 02:21:43 AM (8 years ago)

Author:

boonebgorges

Message:

Introduce 'the_category_list' filter.

Used to filter categories as structured data, before building markup in
get_the_category_list().

We use this filter in addition to upstream filters (such as
'get_the_categories'`) because those upstream filters are used in numerous
contexts, while 'the_category_list' is always used for generating markup
for display.

Props KevinB, ericlewis, SergeyBiryukov, DrewAPicture.
Fixes #9227.

File:

• trunk/src/wp-includes/category-template.php (modified) (1 diff)

trunk/src/wp-includes/category-template.php

@@ -176 +176 @@
     }
 
-    $categories = get_the_category( $post_id );
+    /**
+     * Filter the categories before building the category list.
+     *
+     * @since 4.4.0
+     *
+     * @param array    $categories An array of the post's categories.
+     * @param int|bool $post_id    ID of the post we're retrieving categories for. When `false`, we assume 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 */