X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/699231ae09f7057a4d0000cdf32e50a3df6a04ca..888fa4ed68091f3314f711c5f6fe75858bf5410b:/wp-includes/category-template.php diff --git a/wp-includes/category-template.php b/wp-includes/category-template.php index db55a12c..e627bdc3 100644 --- a/wp-includes/category-template.php +++ b/wp-includes/category-template.php @@ -10,32 +10,21 @@ * Retrieve category link URL. * * @since 1.0.0 - * @uses apply_filters() Calls 'category_link' filter on category link and category ID. + * @see get_term_link() * - * @param int $category_id Category ID. - * @return string + * @param int|object $category Category ID or object. + * @return string Link on success, empty string if category does not exist. */ -function get_category_link( $category_id ) { - global $wp_rewrite; - $catlink = $wp_rewrite->get_category_permastruct(); +function get_category_link( $category ) { + if ( ! is_object( $category ) ) + $category = (int) $category; - if ( empty( $catlink ) ) { - $catlink = home_url('?cat=' . $category_id); - } else { - $category = &get_category( $category_id ); - if ( is_wp_error( $category ) ) - return $category; - $category_nicename = $category->slug; - - if ( $category->parent == $category_id ) // recursive recursion - $category->parent = 0; - elseif ($category->parent != 0 ) - $category_nicename = get_category_parents( $category->parent, false, '/', true ) . $category_nicename; - - $catlink = str_replace( '%category%', $category_nicename, $catlink ); - $catlink = home_url( user_trailingslashit( $catlink, 'category' ) ); - } - return apply_filters( 'category_link', $catlink, $category_id ); + $category = get_term_link( $category, 'category' ); + + if ( is_wp_error( $category ) ) + return ''; + + return $category; } /** @@ -48,18 +37,18 @@ function get_category_link( $category_id ) { * @param string $separator Optional, default is '/'. How to separate categories. * @param bool $nicename Optional, default is false. Whether to use nice name for display. * @param array $visited Optional. Already linked to categories to prevent duplicates. - * @return string + * @return string|WP_Error A list of category parents on success, WP_Error on failure. */ function get_category_parents( $id, $link = false, $separator = '/', $nicename = false, $visited = array() ) { $chain = ''; - $parent = &get_category( $id ); + $parent = get_term( $id, 'category' ); if ( is_wp_error( $parent ) ) return $parent; if ( $nicename ) $name = $parent->slug; else - $name = $parent->cat_name; + $name = $parent->name; if ( $parent->parent && ( $parent->parent != $parent->term_id ) && !in_array( $parent->parent, $visited ) ) { $visited[] = $parent->parent; @@ -67,7 +56,7 @@ function get_category_parents( $id, $link = false, $separator = '/', $nicename = } if ( $link ) - $chain .= 'cat_name ) ) . '">'.$name.'' . $separator; + $chain .= 'name ) ) . '">'.$name.'' . $separator; else $chain .= $name.$separator; return $chain; @@ -83,28 +72,24 @@ function get_category_parents( $id, $link = false, $separator = '/', $nicename = * @return array */ function get_the_category( $id = false ) { - global $post; - - $id = (int) $id; - if ( !$id ) - $id = (int) $post->ID; - - $categories = get_object_term_cache( $id, 'category' ); - if ( false === $categories ) { - $categories = wp_get_object_terms( $id, 'category' ); - wp_cache_add($id, $categories, 'category_relationships'); - } - - if ( !empty( $categories ) ) - usort( $categories, '_usort_terms_by_name' ); - else + $categories = get_the_terms( $id, 'category' ); + if ( ! $categories || is_wp_error( $categories ) ) $categories = array(); - foreach ( (array) array_keys( $categories ) as $key ) { + $categories = array_values( $categories ); + + foreach ( array_keys( $categories ) as $key ) { _make_cat_compat( $categories[$key] ); } - return $categories; + /** + * Filter the array of categories to return for a post. + * + * @since 3.1.0 + * + * @param array $categories An array of categories to return for the post. + */ + return apply_filters( 'get_the_categories', $categories ); } /** @@ -152,14 +137,16 @@ function _usort_terms_by_ID( $a, $b ) { * @since 0.71 * * @param int $cat_ID Category ID. - * @return string Category name. + * @return string|WP_Error Category name on success, WP_Error on failure. */ function get_the_category_by_ID( $cat_ID ) { $cat_ID = (int) $cat_ID; - $category = &get_category( $cat_ID ); + $category = get_term( $cat_ID, 'category' ); + if ( is_wp_error( $category ) ) return $category; - return $category->name; + + return ( $category ) ? $category->name : ''; } /** @@ -174,12 +161,16 @@ function get_the_category_by_ID( $cat_ID ) { */ function get_the_category_list( $separator = '', $parents='', $post_id = false ) { global $wp_rewrite; - $categories = get_the_category( $post_id ); - if ( !is_object_in_taxonomy( get_post_type( $post_id ), 'category' ) ) + if ( ! is_object_in_taxonomy( get_post_type( $post_id ), 'category' ) ) { + /** This filter is documented in wp-includes/category-template.php */ return apply_filters( 'the_category', '', $separator, $parents ); + } - if ( empty( $categories ) ) + $categories = get_the_category( $post_id ); + if ( empty( $categories ) ) { + /** This filter is documented in wp-includes/category-template.php */ return apply_filters( 'the_category', __( 'Uncategorized' ), $separator, $parents ); + } $rel = ( is_object( $wp_rewrite ) && $wp_rewrite->using_permalinks() ) ? 'rel="category tag"' : 'rel="category"'; @@ -192,17 +183,17 @@ function get_the_category_list( $separator = '', $parents='', $post_id = false ) case 'multiple': if ( $category->parent ) $thelist .= get_category_parents( $category->parent, true, $separator ); - $thelist .= 'name ) ) . '" ' . $rel . '>' . $category->name.''; + $thelist .= 'name ) ) . '" ' . $rel . '>' . $category->name.''; break; case 'single': - $thelist .= 'name ) ) . '" ' . $rel . '>'; + $thelist .= 'name ) ) . '" ' . $rel . '>'; if ( $category->parent ) $thelist .= get_category_parents( $category->parent, false, $separator ); $thelist .= $category->name.''; break; case '': default: - $thelist .= 'name ) ) . '" ' . $rel . '>' . $category->cat_name.''; + $thelist .= 'name ) ) . '" ' . $rel . '>' . $category->name.''; } } $thelist .= ''; @@ -215,25 +206,35 @@ function get_the_category_list( $separator = '', $parents='', $post_id = false ) case 'multiple': if ( $category->parent ) $thelist .= get_category_parents( $category->parent, true, $separator ); - $thelist .= 'name ) ) . '" ' . $rel . '>' . $category->cat_name.''; + $thelist .= 'name ) ) . '" ' . $rel . '>' . $category->name.''; break; case 'single': - $thelist .= 'name ) ) . '" ' . $rel . '>'; + $thelist .= 'name ) ) . '" ' . $rel . '>'; if ( $category->parent ) $thelist .= get_category_parents( $category->parent, false, $separator ); - $thelist .= "$category->cat_name"; + $thelist .= "$category->name"; break; case '': default: - $thelist .= 'name ) ) . '" ' . $rel . '>' . $category->name.''; + $thelist .= 'name ) ) . '" ' . $rel . '>' . $category->name.''; } ++$i; } } + + /** + * Filter the category or list of categories. + * + * @since 1.2.0 + * + * @param array $thelist List of categories for the current post. + * @param string $separator Separator used between the categories. + * @param string $parents How to display the category parents. Accepts 'multiple', + * 'single', or empty. + */ return apply_filters( 'the_category', $thelist, $separator, $parents ); } - /** * Check if the current post in within any of the given categories. * @@ -247,30 +248,17 @@ function get_the_category_list( $separator = '', $parents='', $post_id = false ) * As of 2.7, the function can be used anywhere if it is provided a post ID or post object. * * @since 1.2.0 + * @uses has_category() * - * @uses is_object_in_term() - * - * @param int|string|array $category. Category ID, name or slug, or array of said. - * @param int|post object Optional. Post to check instead of the current post. @since 2.7.0 + * @param int|string|array $category Category ID, name or slug, or array of said. + * @param int|object $post Optional. Post to check instead of the current post. (since 2.7.0) * @return bool True if the current post is in any of the given categories. */ -function in_category( $category, $_post = null ) { +function in_category( $category, $post = null ) { if ( empty( $category ) ) return false; - if ( $_post ) { - $_post = get_post( $_post ); - } else { - $_post =& $GLOBALS['post']; - } - - if ( !$_post ) - return false; - - $r = is_object_in_term( $_post->ID, 'category', $category ); - if ( is_wp_error( $r ) ) - return false; - return $r; + return has_category( $category, $post ); } /** @@ -307,7 +295,6 @@ function category_description( $category = 0 ) { * 'orderby' (string) default is 'ID' - What column to use for ordering the * categories. * 'order' (string) default is 'ASC' - What direction to order categories. - * 'show_last_update' (bool|int) default is 0 - See {@link get_categories()} * 'show_count' (bool|int) default is 0 - Whether to show how many posts are * in the category. * 'hide_empty' (bool|int) default is 1 - Whether to hide categories that @@ -337,7 +324,7 @@ function wp_dropdown_categories( $args = '' ) { $defaults = array( 'show_option_all' => '', 'show_option_none' => '', 'orderby' => 'id', 'order' => 'ASC', - 'show_last_update' => 0, 'show_count' => 0, + 'show_count' => 0, 'hide_empty' => 1, 'child_of' => 0, 'exclude' => '', 'echo' => 1, 'selected' => 0, 'hierarchical' => 0, @@ -361,7 +348,6 @@ function wp_dropdown_categories( $args = '' ) { $r['pad_counts'] = true; } - $r['include_last_update_time'] = $r['show_last_update']; extract( $r ); $tab_index_attribute = ''; @@ -379,6 +365,21 @@ function wp_dropdown_categories( $args = '' ) { $output = ''; if ( empty($categories) && ! $r['hide_if_empty'] && !empty($show_option_none) ) { + + /** + * Filter a taxonomy drop-down display element. + * + * A variety of taxonomy drop-down display elements can be modified + * just prior to display via this filter. Filterable arguments include + * 'show_option_none', 'show_option_all', and various forms of the + * term name. + * + * @since 1.2.0 + * + * @see wp_dropdown_categories() + * + * @param string $element Taxonomy element to list. + */ $show_option_none = apply_filters( 'list_cats', $show_option_none ); $output .= "\t\n"; } @@ -386,12 +387,16 @@ function wp_dropdown_categories( $args = '' ) { if ( ! empty( $categories ) ) { if ( $show_option_all ) { + + /** This filter is documented in wp-includes/category-template.php */ $show_option_all = apply_filters( 'list_cats', $show_option_all ); $selected = ( '0' === strval($r['selected']) ) ? " selected='selected'" : ''; $output .= "\t\n"; } if ( $show_option_none ) { + + /** This filter is documented in wp-includes/category-template.php */ $show_option_none = apply_filters( 'list_cats', $show_option_none ); $selected = ( '-1' === strval($r['selected']) ) ? " selected='selected'" : ''; $output .= "\t\n"; @@ -404,11 +409,19 @@ function wp_dropdown_categories( $args = '' ) { $output .= walk_category_dropdown_tree( $categories, $depth, $r ); } + if ( ! $r['hide_if_empty'] || ! empty($categories) ) $output .= "\n"; - - $output = apply_filters( 'wp_dropdown_cats', $output ); + /** + * Filter the taxonomy drop-down output. + * + * @since 2.1.0 + * + * @param string $output HTML output. + * @param array $r Arguments used to build the drop-down. + */ + $output = apply_filters( 'wp_dropdown_cats', $output, $r ); if ( $echo ) echo $output; @@ -424,8 +437,6 @@ function wp_dropdown_categories( $args = '' ) { * 'orderby' (string) default is 'ID' - What column to use for ordering the * categories. * 'order' (string) default is 'ASC' - What direction to order categories. - * 'show_last_update' (bool|int) default is 0 - See {@link - * walk_category_dropdown_tree()} * 'show_count' (bool|int) default is 0 - Whether to show how many posts are * in the category. * 'hide_empty' (bool|int) default is 1 - Whether to hide categories that @@ -453,7 +464,7 @@ function wp_list_categories( $args = '' ) { $defaults = array( 'show_option_all' => '', 'show_option_none' => __('No categories'), 'orderby' => 'name', 'order' => 'ASC', - 'show_last_update' => 0, 'style' => 'list', + 'style' => 'list', 'show_count' => 0, 'hide_empty' => 1, 'use_desc_for_title' => 1, 'child_of' => 0, 'feed' => '', 'feed_type' => '', @@ -469,9 +480,6 @@ function wp_list_categories( $args = '' ) { if ( !isset( $r['pad_counts'] ) && $r['show_count'] && $r['hierarchical'] ) $r['pad_counts'] = true; - if ( isset( $r['show_date'] ) ) - $r['include_last_update_time'] = $r['show_date']; - if ( true == $r['hierarchical'] ) { $r['exclude_tree'] = $r['exclude']; $r['exclude'] = ''; @@ -489,26 +497,30 @@ function wp_list_categories( $args = '' ) { $output = ''; if ( $title_li && 'list' == $style ) - $output = '
  • ' . $title_li . '