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 |
---|---|
163 | * @param string $separator Optional, default is empty string. Separator for between the categories. |
164 | * @param string $parents Optional. How to display the parents. |
165 | * @param int $post_id Optional. Post ID to retrieve categories. |
166 | * @return string |
167 | */ |
168 | function get_the_category_list( $separator = '', $parents='', $post_id = false ) { |
169 | global $wp_rewrite; |
170 | if ( ! is_object_in_taxonomy( get_post_type( $post_id ), 'category' ) ) { |
171 | /** This filter is documented in wp-includes/category-template.php */ |
172 | return apply_filters( 'the_category', '', $separator, $parents ); |
173 | } |
174 |
|
175 | $categories = get_the_category( $post_id ); |
176 | if ( empty( $categories ) ) { |
177 | /** This filter is documented in wp-includes/category-template.php */ |
178 | return apply_filters( 'the_category', __( 'Uncategorized' ), $separator, $parents ); |
179 | } |
180 |
|
181 | $rel = ( is_object( $wp_rewrite ) && $wp_rewrite->using_permalinks() ) ? 'rel="category tag"' : 'rel="category"'; |
182 |
|
183 | $thelist = ''; |
184 | if ( '' == $separator ) { |
185 | $thelist .= '<ul class="post-categories">'; |
186 | foreach ( $categories as $category ) { |
187 | $thelist .= "\n\t<li>"; |
Line | Code |
232 | * Filter the category or list of categories. |
233 | * |
234 | * @since 1.2.0 |
235 | * |
236 | * @param array $thelist List of categories for the current post. |
237 | * @param string $separator Separator used between the categories. |
238 | * @param string $parents How to display the category parents. Accepts 'multiple', |
239 | * 'single', or empty. |
240 | */ |
241 | return apply_filters( 'the_category', $thelist, $separator, $parents ); |
242 | } |
243 |
|
244 | /** |
245 | * Check if the current post in within any of the given categories. |
246 | * |
247 | * The given categories are checked against the post's categories' term_ids, names and slugs. |
248 | * Categories given as integers will only be checked against the post's categories' term_ids. |
249 | * |
250 | * Prior to v2.5 of WordPress, category names were not supported. |