WP hooks navigation: Home/browse • Actions index • Filters index
To save our bandwidth, we show only a snippet of code around each occurence of the hook. View complete file in SVN (without highlighting).
The best way to understand what a hook does is to look at where it occurs in the source code.
do_action( "hook_name" )apply_filters( "hook_name", "what_to_filter" ).Remember, this hook may occur in more than one file. Moreover, the hook's context may change from version to version.
This hook occurs 3 times in this file.
| Line | Code |
|---|---|
| 136 | * @param string $parents Optional. How to display the parents. |
| 137 | * @param int $post_id Optional. Post ID to retrieve categories. |
| 138 | * @return string Category list for a post. |
| 139 | */ |
| 140 | function get_the_category_list( $separator = '', $parents = '', $post_id = false ) { |
| 141 | global $wp_rewrite; |
| 142 | |
| 143 | if ( ! is_object_in_taxonomy( get_post_type( $post_id ), 'category' ) ) { |
| 144 | /** This filter is documented in wp-includes/category-template.php */ |
| 145 | return apply_filters( 'the_category', '', $separator, $parents ); |
| 146 | } |
| 147 | |
| 148 | /** |
| 149 | * Filters the categories before building the category list. |
| 150 | * |
| 151 | * @since 4.4.0 |
| 152 | * |
| 153 | * @param WP_Term[] $categories An array of the post's categories. |
| 154 | * @param int|bool $post_id ID of the post we're retrieving categories for. |
| 155 | * When `false`, we assume the current post in the loop. |
| 156 | */ |
| 157 | $categories = apply_filters( 'the_category_list', get_the_category( $post_id ), $post_id ); |
| 158 | |
| 159 | if ( empty( $categories ) ) { |
| 160 | /** This filter is documented in wp-includes/category-template.php */ |
| 161 | return apply_filters( 'the_category', __( 'Uncategorized' ), $separator, $parents ); |
| 162 | } |
| 163 | |
| 164 | $rel = ( is_object( $wp_rewrite ) && $wp_rewrite->using_permalinks() ) ? 'rel="category tag"' : 'rel="category"'; |
| 165 | |
| 166 | $thelist = ''; |
| 167 | if ( '' === $separator ) { |
| 168 | $thelist .= '<ul class="post-categories">'; |
| 169 | foreach ( $categories as $category ) { |
| 170 | $thelist .= "\n\t<li>"; |
| Line | Code |
| 220 | * Filters the category or list of categories. |
| 221 | * |
| 222 | * @since 1.2.0 |
| 223 | * |
| 224 | * @param string $thelist List of categories for the current post. |
| 225 | * @param string $separator Separator used between the categories. |
| 226 | * @param string $parents How to display the category parents. Accepts 'multiple', |
| 227 | * 'single', or empty. |
| 228 | */ |
| 229 | return apply_filters( 'the_category', $thelist, $separator, $parents ); |
| 230 | } |
| 231 | |
| 232 | /** |
| 233 | * Checks if the current post is within any of the given categories. |
| 234 | * |
| 235 | * The given categories are checked against the post's categories' term_ids, names and slugs. |
| 236 | * Categories given as integers will only be checked against the post's categories' term_ids. |
| 237 | * |
| 238 | * Prior to v2.5 of WordPress, category names were not supported. |