X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/dc1231b7312fbdca99e9e887cc2bb35a28f85cdc..refs/tags/wordpress-4.4:/wp-includes/category-template.php
diff --git a/wp-includes/category-template.php b/wp-includes/category-template.php
index 6bac6c11..9b685edb 100644
--- a/wp-includes/category-template.php
+++ b/wp-includes/category-template.php
@@ -1,9 +1,10 @@
link", 2: "taxonomy => link_category" alternative */
+ _deprecated_argument( __FUNCTION__, '3.0',
+ sprintf( __( '%1$s is deprecated. Use %2$s instead.' ),
+ 'type => link',
+ 'taxonomy => link_category'
+ )
+ );
$args['taxonomy'] = 'link_category';
}
@@ -460,32 +479,48 @@ function wp_dropdown_categories( $args = '' ) {
/**
* Display or retrieve the HTML list of categories.
*
- * The list of arguments is below:
- * 'show_option_all' (string) - Text to display for showing all categories.
- * '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.
- * 'use_desc_for_title' (bool|int) default is 1 - Whether to use the
- * category description as the title attribute.
- * 'feed' - See {@link get_categories()}.
- * 'feed_type' - See {@link get_categories()}.
- * 'feed_image' - See {@link get_categories()}.
- * 'child_of' (int) default is 0 - See {@link get_categories()}.
- * 'exclude' (string) - See {@link get_categories()}.
- * 'exclude_tree' (string) - See {@link get_categories()}.
- * 'echo' (bool|int) default is 1 - Whether to display or retrieve content.
- * 'current_category' (int) - See {@link get_categories()}.
- * 'hierarchical' (bool) - See {@link get_categories()}.
- * 'title_li' (string) - See {@link get_categories()}.
- * 'depth' (int) - The max depth.
- *
* @since 2.1.0
+ * @since 4.4.0 Introduced the `hide_title_if_empty` and `separator` arguments. The `current_category` argument was modified to
+ * optionally accept an array of values.
*
- * @param string|array $args Optional. Override default arguments.
+ * @param string|array $args {
+ * Array of optional arguments.
+ *
+ * @type string $show_option_all Text to display for showing all categories. Default empty string.
+ * @type string $show_option_none Text to display for the 'no categories' option.
+ * Default 'No categories'.
+ * @type string $orderby The column to use for ordering categories. Default 'ID'.
+ * @type string $order Which direction to order categories. Accepts 'ASC' or 'DESC'.
+ * Default 'ASC'.
+ * @type bool|int $show_count Whether to show how many posts are in the category. Default 0.
+ * @type bool|int $hide_empty Whether to hide categories that don't have any posts attached to them.
+ * Default 1.
+ * @type bool|int $use_desc_for_title Whether to use the category description as the title attribute.
+ * Default 1.
+ * @type string $feed Text to use for the feed link. Default 'Feed for all posts filed
+ * under [cat name]'.
+ * @type string $feed_type Feed type. Used to build feed link. See {@link get_term_feed_link()}.
+ * Default empty string (default feed).
+ * @type string $feed_image URL of an image to use for the feed link. Default empty string.
+ * @type int $child_of Term ID to retrieve child terms of. See {@link get_terms()}. Default 0.
+ * @type array|string $exclude Array or comma/space-separated string of term IDs to exclude.
+ * If `$hierarchical` is true, descendants of `$exclude` terms will also
+ * be excluded; see `$exclude_tree`. See {@link get_terms()}.
+ * Default empty string.
+ * @type array|string $exclude_tree Array or comma/space-separated string of term IDs to exclude, along
+ * with their descendants. See {@link get_terms()}. Default empty string.
+ * @type bool|int $echo True to echo markup, false to return it. Default 1.
+ * @type int|array $current_category ID of category, or array of IDs of categories, that should get the
+ * 'current-cat' class. Default 0.
+ * @type bool $hierarchical Whether to include terms that have non-empty descendants.
+ * See {@link get_terms()}. Default true.
+ * @type string $title_li Text to use for the list title `
` element. Pass an empty string
+ * to disable. Default 'Categories'.
+ * @type bool $hide_title_if_empty Whether to hide the `$title_li` element if there are no terms in
+ * the list. Default false (title will always be shown).
+ * @type int $depth Category depth. Used for tab indentation. Default 0.
+ * @type string $taxonomy Taxonomy name. Default 'category'.
+ * }
* @return false|string HTML content only if 'echo' argument is 0.
*/
function wp_list_categories( $args = '' ) {
@@ -499,7 +534,9 @@ function wp_list_categories( $args = '' ) {
'feed_image' => '', 'exclude' => '',
'exclude_tree' => '', 'current_category' => 0,
'hierarchical' => true, 'title_li' => __( 'Categories' ),
+ 'hide_title_if_empty' => false,
'echo' => 1, 'depth' => 0,
+ 'separator' => ' ',
'taxonomy' => 'category'
);
@@ -508,8 +545,19 @@ function wp_list_categories( $args = '' ) {
if ( !isset( $r['pad_counts'] ) && $r['show_count'] && $r['hierarchical'] )
$r['pad_counts'] = true;
+ // Descendants of exclusions should be excluded too.
if ( true == $r['hierarchical'] ) {
- $r['exclude_tree'] = $r['exclude'];
+ $exclude_tree = array();
+
+ if ( $r['exclude_tree'] ) {
+ $exclude_tree = array_merge( $exclude_tree, (array) $r['exclude_tree'] );
+ }
+
+ if ( $r['exclude'] ) {
+ $exclude_tree = array_merge( $exclude_tree, (array) $r['exclude'] );
+ }
+
+ $r['exclude_tree'] = $exclude_tree;
$r['exclude'] = '';
}
@@ -526,7 +574,7 @@ function wp_list_categories( $args = '' ) {
$categories = get_categories( $r );
$output = '';
- if ( $r['title_li'] && 'list' == $r['style'] ) {
+ if ( $r['title_li'] && 'list' == $r['style'] && ( ! empty( $categories ) || ! $r['hide_title_if_empty'] ) ) {
$output = '
' . $r['title_li'] . '
';
}
if ( empty( $categories ) ) {
@@ -556,9 +604,13 @@ function wp_list_categories( $args = '' ) {
}
}
- // Fallback for the 'All' link is the front page.
+ // Fallback for the 'All' link is the posts 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( '/' );
+ if ( 'page' == get_option( 'show_on_front' ) && get_option( 'page_for_posts' ) ) {
+ $posts_page = get_permalink( get_option( 'page_for_posts' ) );
+ } else {
+ $posts_page = home_url( '/' );
+ }
}
$posts_page = esc_url( $posts_page );
@@ -957,267 +1009,6 @@ function walk_category_dropdown_tree() {
return call_user_func_array( array( $walker, 'walk' ), $args );
}
-/**
- * Create HTML list of categories.
- *
- * @package WordPress
- * @since 2.1.0
- * @uses Walker
- */
-class Walker_Category extends Walker {
- /**
- * What the class handles.
- *
- * @see Walker::$tree_type
- * @since 2.1.0
- * @var string
- */
- public $tree_type = 'category';
-
- /**
- * Database fields to use.
- *
- * @see Walker::$db_fields
- * @since 2.1.0
- * @todo Decouple this
- * @var array
- */
- public $db_fields = array ('parent' => 'parent', 'id' => 'term_id');
-
- /**
- * Starts the list before the elements are added.
- *
- * @see Walker::start_lvl()
- *
- * @since 2.1.0
- *
- * @param string $output Passed by reference. Used to append additional content.
- * @param int $depth Depth of category. Used for tab indentation.
- * @param array $args An array of arguments. Will only append content if style argument value is 'list'.
- * @see wp_list_categories()
- */
- public function start_lvl( &$output, $depth = 0, $args = array() ) {
- if ( 'list' != $args['style'] )
- return;
-
- $indent = str_repeat("\t", $depth);
- $output .= "$indent
\n";
- }
-
- /**
- * Ends the list of after the elements are added.
- *
- * @see Walker::end_lvl()
- *
- * @since 2.1.0
- *
- * @param string $output Passed by reference. Used to append additional content.
- * @param int $depth Depth of category. Used for tab indentation.
- * @param array $args An array of arguments. Will only append content if style argument value is 'list'.
- * @wsee wp_list_categories()
- */
- public function end_lvl( &$output, $depth = 0, $args = array() ) {
- if ( 'list' != $args['style'] )
- return;
-
- $indent = str_repeat("\t", $depth);
- $output .= "$indent
\n";
- }
-
- /**
- * Start the element output.
- *
- * @see Walker::start_el()
- *
- * @since 2.1.0
- *
- * @param string $output Passed by reference. Used to append additional content.
- * @param object $category Category data object.
- * @param int $depth Depth of category in reference to parents. Default 0.
- * @param array $args An array of arguments. @see wp_list_categories()
- * @param int $id ID of the current category.
- */
- public function start_el( &$output, $category, $depth = 0, $args = array(), $id = 0 ) {
- /** This filter is documented in wp-includes/category-template.php */
- $cat_name = apply_filters(
- 'list_cats',
- esc_attr( $category->name ),
- $category
- );
-
- // Don't generate an element if the category name is empty.
- if ( ! $cat_name ) {
- return;
- }
-
- $link = 'description ) ) {
- /**
- * Filter the category description for display.
- *
- * @since 1.2.0
- *
- * @param string $description Category description.
- * @param object $category Category object.
- */
- $link .= 'title="' . esc_attr( strip_tags( apply_filters( 'category_description', $category->description, $category ) ) ) . '"';
- }
-
- $link .= '>';
- $link .= $cat_name . '';
-
- if ( ! empty( $args['feed_image'] ) || ! empty( $args['feed'] ) ) {
- $link .= ' ';
-
- if ( empty( $args['feed_image'] ) ) {
- $link .= '(';
- }
-
- $link .= '';
- }
- $link .= '';
-
- if ( empty( $args['feed_image'] ) ) {
- $link .= ')';
- }
- }
-
- if ( ! empty( $args['show_count'] ) ) {
- $link .= ' (' . number_format_i18n( $category->count ) . ')';
- }
- if ( 'list' == $args['style'] ) {
- $output .= "\tterm_id,
- );
-
- if ( ! empty( $args['current_category'] ) ) {
- $_current_category = get_term( $args['current_category'], $category->taxonomy );
- if ( $category->term_id == $args['current_category'] ) {
- $css_classes[] = 'current-cat';
- } elseif ( $category->term_id == $_current_category->parent ) {
- $css_classes[] = 'current-cat-parent';
- }
- }
-
- /**
- * 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";
- }
- }
-
- /**
- * Ends the element output, if needed.
- *
- * @see Walker::end_el()
- *
- * @since 2.1.0
- *
- * @param string $output Passed by reference. Used to append additional content.
- * @param object $page Not used.
- * @param int $depth Depth of category. Not used.
- * @param array $args An array of arguments. Only uses 'list' for whether should append to output. @see wp_list_categories()
- */
- public function end_el( &$output, $page, $depth = 0, $args = array() ) {
- if ( 'list' != $args['style'] )
- return;
-
- $output .= "
\n";
- }
-
-}
-
-/**
- * Create HTML dropdown list of Categories.
- *
- * @package WordPress
- * @since 2.1.0
- * @uses Walker
- */
-class Walker_CategoryDropdown extends Walker {
- /**
- * @see Walker::$tree_type
- * @since 2.1.0
- * @var string
- */
- public $tree_type = 'category';
-
- /**
- * @see Walker::$db_fields
- * @since 2.1.0
- * @todo Decouple this
- * @var array
- */
- public $db_fields = array ('parent' => 'parent', 'id' => 'term_id');
-
- /**
- * Start the element output.
- *
- * @see Walker::start_el()
- * @since 2.1.0
- *
- * @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', '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);
-
- /** This filter is documented in wp-includes/category-template.php */
- $cat_name = apply_filters( 'list_cats', $category->name, $category );
-
- if ( isset( $args['value_field'] ) && isset( $category->{$args['value_field']} ) ) {
- $value_field = $args['value_field'];
- } else {
- $value_field = 'term_id';
- }
-
- $output .= "\t\n";
- }
-}
-
//
// Tags
//
@@ -1357,9 +1148,15 @@ function get_the_terms( $post, $taxonomy ) {
$terms = get_object_term_cache( $post->ID, $taxonomy );
if ( false === $terms ) {
$terms = wp_get_object_terms( $post->ID, $taxonomy );
- wp_cache_add($post->ID, $terms, $taxonomy . '_relationships');
+ $to_cache = array();
+ foreach ( $terms as $key => $term ) {
+ $to_cache[ $key ] = $term->data;
+ }
+ wp_cache_add( $post->ID, $to_cache, $taxonomy . '_relationships' );
}
+ $terms = array_map( 'get_term', $terms );
+
/**
* Filter the list of terms attached to the given post.
*