X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/af50974463450c98503e763a7836a50e260461a9..dc1231b7312fbdca99e9e887cc2bb35a28f85cdc:/wp-includes/category-template.php diff --git a/wp-includes/category-template.php b/wp-includes/category-template.php index 0f97068f..6bac6c11 100644 --- a/wp-includes/category-template.php +++ b/wp-includes/category-template.php @@ -65,10 +65,15 @@ function get_category_parents( $id, $link = false, $separator = '/', $nicename = /** * Retrieve post categories. * + * This tag may be used outside The Loop by passing a post id as the parameter. + * + * Note: This function only returns results from the default "category" taxonomy. + * For custom taxonomies use get_the_terms(). + * * @since 0.71 * * @param int $id Optional, default to current post ID. The post ID. - * @return array + * @return array Array of objects, one for each category assigned to the post. */ function get_the_category( $id = false ) { $categories = get_the_terms( $id, 'category' ); @@ -153,6 +158,8 @@ function get_the_category_by_ID( $cat_ID ) { * * @since 1.5.1 * + * @global WP_Rewrite $wp_rewrite + * * @param string $separator Optional, default is empty string. Separator for between the categories. * @param string $parents Optional. How to display the parents. * @param int $post_id Optional. Post ID to retrieve categories. @@ -287,36 +294,51 @@ function category_description( $category = 0 ) { /** * Display or retrieve the HTML dropdown list of categories. * - * The list of arguments is below: - * 'show_option_all' (string) - Text to display for showing all categories. - * 'show_option_none' (string) - Text to display for showing no categories. - * 'option_none_value' (mixed) - Value to use when no category is selected. - * 'orderby' (string) default is 'ID' - What column to use for ordering the - * categories. - * 'order' (string) default is 'ASC' - What direction to order 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 - * don't have any posts attached to them. - * 'child_of' (int) default is 0 - See {@link get_categories()}. - * 'exclude' (string) - See {@link get_categories()}. - * 'echo' (bool|int) default is 1 - Whether to display or retrieve content. - * 'depth' (int) - The max depth. - * 'tab_index' (int) - Tab index for select element. - * 'name' (string) - The name attribute value for select element. - * 'id' (string) - The ID attribute value for select element. Defaults to name if omitted. - * 'class' (string) - The class attribute value for select element. - * 'selected' (int) - Which category ID is selected. - * 'taxonomy' (string) - The name of the taxonomy to retrieve. Defaults to category. - * * The 'hierarchical' argument, which is disabled by default, will override the * depth argument, unless it is true. When the argument is false, it will * display all of the categories. When it is enabled it will use the value in * the 'depth' argument. * * @since 2.1.0 - * - * @param string|array $args Optional. Override default arguments. + * @since 4.2.0 Introduced the `value_field` argument. + * + * @param string|array $args { + * Optional. Array or string of arguments to generate a categories drop-down element. + * + * @type string $show_option_all Text to display for showing all categories. Default empty. + * @type string $show_option_none Text to display for showing no categories. Default empty. + * @type string $option_none_value Value to use when no category is selected. Default empty. + * @type string $orderby Which column to use for ordering categories. See get_terms() for a list + * of accepted values. Default 'id' (term_id). + * @type string $order Whether to order terms in ascending or descending order. Accepts 'ASC' + * or 'DESC'. Default 'ASC'. + * @type bool $pad_counts See get_terms() for an argument description. Default false. + * @type bool|int $show_count Whether to include post counts. Accepts 0, 1, or their bool equivalents. + * Default 0. + * @type bool|int $hide_empty Whether to hide categories that don't have any posts. Accepts 0, 1, or + * their bool equivalents. Default 1. + * @type int $child_of Term ID to retrieve child terms of. See get_terms(). Default 0. + * @type array|string $exclude Array or comma/space-separated string of term ids to exclude. + * If `$include` is non-empty, `$exclude` is ignored. Default empty array. + * @type bool|int $echo Whether to echo or return the generated markup. Accepts 0, 1, or their + * bool equivalents. Default 1. + * @type bool|int $hierarchical Whether to traverse the taxonomy hierarchy. Accepts 0, 1, or their bool + * equivalents. Default 0. + * @type int $depth Maximum depth. Default 0. + * @type int $tab_index Tab index for the select element. Default 0 (no tabindex). + * @type string $name Value for the 'name' attribute of the select element. Default 'cat'. + * @type string $id Value for the 'id' attribute of the select element. Defaults to the value + * of `$name`. + * @type string $class Value for the 'class' attribute of the select element. Default 'postform'. + * @type int|string $selected Value of the option that should be selected. Default 0. + * @type string $value_field Term field that should be used to populate the 'value' attribute + * of the option elements. Accepts any valid term field: 'term_id', 'name', + * 'slug', 'term_group', 'term_taxonomy_id', 'taxonomy', 'description', + * 'parent', 'count'. Default 'term_id'. + * @type string $taxonomy Name of the category to retrieve. Default 'category'. + * @type bool $hide_if_empty True to skip generating markup if no categories are found. + * Default false (create select element even if no categories are found). + * } * @return string HTML content only if 'echo' argument is 0. */ function wp_dropdown_categories( $args = '' ) { @@ -330,7 +352,8 @@ function wp_dropdown_categories( $args = '' ) { 'name' => 'cat', 'id' => '', 'class' => 'postform', 'depth' => 0, 'tab_index' => 0, 'taxonomy' => 'category', - 'hide_if_empty' => false, 'option_none_value' => -1 + 'hide_if_empty' => false, 'option_none_value' => -1, + 'value_field' => 'term_id', ); $defaults['selected'] = ( is_category() ) ? get_query_var( 'cat' ) : 0; @@ -354,7 +377,12 @@ function wp_dropdown_categories( $args = '' ) { if ( (int) $tab_index > 0 ) { $tab_index_attribute = " tabindex=\"$tab_index\""; } - $categories = get_terms( $r['taxonomy'], $r ); + + // Avoid clashes with the 'name' param of get_terms(). + $get_terms_args = $r; + unset( $get_terms_args['name'] ); + $categories = get_terms( $r['taxonomy'], $get_terms_args ); + $name = esc_attr( $r['name'] ); $class = esc_attr( $r['class'] ); $id = $r['id'] ? esc_attr( $r['id'] ) : $name; @@ -458,7 +486,7 @@ function wp_dropdown_categories( $args = '' ) { * @since 2.1.0 * * @param string|array $args Optional. Override default arguments. - * @return false|null|string HTML content only if 'echo' argument is 0. + * @return false|string HTML content only if 'echo' argument is 0. */ function wp_list_categories( $args = '' ) { $defaults = array( @@ -511,7 +539,28 @@ function wp_list_categories( $args = '' ) { } } else { if ( ! empty( $show_option_all ) ) { - $posts_page = ( 'page' == get_option( 'show_on_front' ) && get_option( 'page_for_posts' ) ) ? get_permalink( get_option( 'page_for_posts' ) ) : home_url( '/' ); + + $posts_page = ''; + + // For taxonomies that belong only to custom post types, point to a valid archive. + $taxonomy_object = get_taxonomy( $r['taxonomy'] ); + if ( ! in_array( 'post', $taxonomy_object->object_type ) && ! in_array( 'page', $taxonomy_object->object_type ) ) { + foreach ( $taxonomy_object->object_type as $object_type ) { + $_object_type = get_post_type_object( $object_type ); + + // Grab the first one. + if ( ! empty( $_object_type->has_archive ) ) { + $posts_page = get_post_type_archive_link( $object_type ); + break; + } + } + } + + // Fallback for the 'All' link is the front page. + if ( ! $posts_page ) { + $posts_page = 'page' == get_option( 'show_on_front' ) && get_option( 'page_for_posts' ) ? get_permalink( get_option( 'page_for_posts' ) ) : home_url( '/' ); + } + $posts_page = esc_url( $posts_page ); if ( 'list' == $r['style'] ) { $output .= "
  • $show_option_all
    • "; @@ -587,7 +636,8 @@ function wp_list_categories( $args = '' ) { * @since 2.3.0 * * @param array|string|null $args Optional. Override default arguments. - * @return null|false Generated tag cloud, only if no failures and 'array' is set for the 'format' argument. + * @return void|array Generated tag cloud, only if no failures and 'array' is set for the 'format' argument. + * Otherwise, this function outputs the tag cloud. */ function wp_tag_cloud( $args = '' ) { $defaults = array( @@ -608,7 +658,7 @@ function wp_tag_cloud( $args = '' ) { else $link = get_term_link( intval($tag->term_id), $tag->taxonomy ); if ( is_wp_error( $link ) ) - return false; + return; $tags[ $key ]->link = $link; $tags[ $key ]->id = $tag->term_id; @@ -635,8 +685,8 @@ function wp_tag_cloud( $args = '' ) { /** * Default topic count scaling for tag links * - * @param integer $count number of posts with that tag - * @return integer scaled count + * @param int $count number of posts with that tag + * @return int scaled count */ function default_topic_count_scale( $count ) { return round(log10($count + 1) * 100); @@ -763,24 +813,46 @@ function wp_generate_tag_cloud( $tags, $args = '' ) { $font_spread = 1; $font_step = $font_spread / $spread; - $a = array(); - + // Assemble the data that will be used to generate the tag cloud markup. + $tags_data = array(); foreach ( $tags as $key => $tag ) { + $tag_id = isset( $tag->id ) ? $tag->id : $key; + $count = $counts[ $key ]; $real_count = $real_counts[ $key ]; - $tag_link = '#' != $tag->link ? esc_url( $tag->link ) : '#'; - $tag_id = isset($tags[ $key ]->id) ? $tags[ $key ]->id : $key; - $tag_name = $tags[ $key ]->name; if ( $translate_nooped_plural ) { - $title_attribute = sprintf( translate_nooped_plural( $translate_nooped_plural, $real_count ), number_format_i18n( $real_count ) ); + $title = sprintf( translate_nooped_plural( $translate_nooped_plural, $real_count ), number_format_i18n( $real_count ) ); } else { - $title_attribute = call_user_func( $args['topic_count_text_callback'], $real_count, $tag, $args ); + $title = call_user_func( $args['topic_count_text_callback'], $real_count, $tag, $args ); } - $a[] = "$tag_name"; + $tags_data[] = array( + 'id' => $tag_id, + 'url' => '#' != $tag->link ? $tag->link : '#', + 'name' => $tag->name, + 'title' => $title, + 'slug' => $tag->slug, + 'real_count' => $real_count, + 'class' => 'tag-link-' . $tag_id, + 'font_size' => $args['smallest'] + ( $count - $min_count ) * $font_step, + ); + } + + /** + * Filter the data used to generate the tag cloud. + * + * @since 4.3.0 + * + * @param array $tags_data An array of term data for term used to generate the tag cloud. + */ + $tags_data = apply_filters( 'wp_generate_tag_cloud_data', $tags_data ); + + $a = array(); + + // generate the output links array + foreach ( $tags_data as $key => $tag_data ) { + $a[] = "" . esc_html( $tag_data['name'] ) . ""; } switch ( $args['format'] ) { @@ -826,6 +898,7 @@ function wp_generate_tag_cloud( $tags, $args = '' ) { * * @since 3.1.0 * @access private + * @return int */ function _wp_object_name_sort_cb( $a, $b ) { return strnatcasecmp( $a->name, $b->name ); @@ -836,6 +909,7 @@ function _wp_object_name_sort_cb( $a, $b ) { * * @since 3.1.0 * @access private + * @return bool */ function _wp_object_count_sort_cb( $a, $b ) { return ( $a->count > $b->count ); @@ -851,16 +925,17 @@ function _wp_object_count_sort_cb( $a, $b ) { * @uses Walker_Category to create HTML list content. * @since 2.1.0 * @see Walker_Category::walk() for parameters and return description. + * @return string */ function walk_category_tree() { $args = func_get_args(); // the user's options are the third parameter - if ( empty($args[2]['walker']) || !is_a($args[2]['walker'], 'Walker') ) + if ( empty( $args[2]['walker'] ) || ! ( $args[2]['walker'] instanceof Walker ) ) { $walker = new Walker_Category; - else + } else { $walker = $args[2]['walker']; - - return call_user_func_array(array( &$walker, 'walk' ), $args ); + } + return call_user_func_array( array( $walker, 'walk' ), $args ); } /** @@ -869,16 +944,17 @@ function walk_category_tree() { * @uses Walker_CategoryDropdown to create HTML dropdown content. * @since 2.1.0 * @see Walker_CategoryDropdown::walk() for parameters and return description. + * @return string */ function walk_category_dropdown_tree() { $args = func_get_args(); // the user's options are the third parameter - if ( empty($args[2]['walker']) || !is_a($args[2]['walker'], 'Walker') ) + if ( empty( $args[2]['walker'] ) || ! ( $args[2]['walker'] instanceof Walker ) ) { $walker = new Walker_CategoryDropdown; - else + } else { $walker = $args[2]['walker']; - - return call_user_func_array(array( &$walker, 'walk' ), $args ); + } + return call_user_func_array( array( $walker, 'walk' ), $args ); } /** @@ -969,6 +1045,11 @@ class Walker_Category extends Walker { $category ); + // Don't generate an element if the category name is empty. + if ( ! $cat_name ) { + return; + } + $link = 'description ) ) { /** @@ -1021,16 +1102,35 @@ class Walker_Category extends Walker { } if ( 'list' == $args['style'] ) { $output .= "\tterm_id; + $css_classes = array( + 'cat-item', + 'cat-item-' . $category->term_id, + ); + if ( ! empty( $args['current_category'] ) ) { $_current_category = get_term( $args['current_category'], $category->taxonomy ); if ( $category->term_id == $args['current_category'] ) { - $class .= ' current-cat'; + $css_classes[] = 'current-cat'; } elseif ( $category->term_id == $_current_category->parent ) { - $class .= ' current-cat-parent'; + $css_classes[] = 'current-cat-parent'; } } - $output .= ' class="' . $class . '"'; + + /** + * Filter the list of CSS classes to include with each category in the list. + * + * @since 4.2.0 + * + * @see wp_list_categories() + * + * @param array $css_classes An array of CSS classes to be applied to each list item. + * @param object $category Category data object. + * @param int $depth Depth of page, used for padding. + * @param array $args An array of wp_list_categories() arguments. + */ + $css_classes = implode( ' ', apply_filters( 'category_css_class', $css_classes, $category, $depth, $args ) ); + + $output .= ' class="' . $css_classes . '"'; $output .= ">$link\n"; } else { $output .= "\t$link
    \n"; @@ -1090,7 +1190,8 @@ class Walker_CategoryDropdown extends Walker { * @param string $output Passed by reference. Used to append additional content. * @param object $category Category data object. * @param int $depth Depth of category. Used for padding. - * @param array $args Uses 'selected' and 'show_count' keys, if they exist. @see wp_dropdown_categories() + * @param array $args Uses 'selected', 'show_count', and 'value_field' keys, if they exist. + * See {@see wp_dropdown_categories()}. */ public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) { $pad = str_repeat(' ', $depth * 3); @@ -1098,8 +1199,16 @@ class Walker_CategoryDropdown extends Walker { /** This filter is documented in wp-includes/category-template.php */ $cat_name = apply_filters( 'list_cats', $category->name, $category ); - $output .= "\t    '; + } + $links[] = ''; } /** @@ -1304,9 +1416,9 @@ function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = '' * * @since 2.5.0 * - * @param array $term_links An array of term links. + * @param array $links An array of term links. */ - $term_links = apply_filters( "term_links-$taxonomy", $term_links ); + $term_links = apply_filters( "term_links-$taxonomy", $links ); return $before . join( $sep, $term_links ) . $after; } @@ -1321,7 +1433,7 @@ function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = '' * @param string $before Optional. Before list. * @param string $sep Optional. Separate items using this. * @param string $after Optional. After list. - * @return false|null False on WordPress error. Returns null when displaying. + * @return false|void False on WordPress error. */ function the_terms( $id, $taxonomy, $before = '', $sep = ', ', $after = '' ) { $term_list = get_the_term_list( $id, $taxonomy, $before, $sep, $after );