X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/wordpress.git/blobdiff_plain/9e77185fafaf4e60e2b73821e0e4b9b1a11fb85f..784f914b1e4b1c62d6657e86397c2e83bcee4295:/wp-includes/category-template.php
diff --git a/wp-includes/category-template.php b/wp-includes/category-template.php
index 7369fda9..35d6c82e 100644
--- a/wp-includes/category-template.php
+++ b/wp-includes/category-template.php
@@ -1,9 +1,10 @@
'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;
// Back compat.
if ( isset( $args['type'] ) && 'link' == $args['type'] ) {
- _deprecated_argument( __FUNCTION__, '3.0', '' );
+ /* translators: 1: "type => 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';
}
@@ -356,7 +396,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;
@@ -434,47 +479,75 @@ 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
- *
- * @param string|array $args Optional. Override default arguments.
- * @return string HTML content only if 'echo' argument is 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 {
+ * 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 `
";
@@ -588,8 +697,9 @@ function wp_list_categories( $args = '' ) {
*
* @since 2.3.0
*
- * @param array|string $args Optional. Override default arguments.
- * @return array Generated tag cloud, only if no failures and 'array' is set for the 'format' argument.
+ * @param array|string|null $args Optional. Override default arguments.
+ * @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(
@@ -610,7 +720,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;
@@ -637,8 +747,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);
@@ -765,24 +875,47 @@ 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 ) {
+ $class = $tag_data['class'] . ' tag-link-position-' . ( $key + 1 );
+ $a[] = "" . esc_html( $tag_data['name'] ) . "";
}
switch ( $args['format'] ) {
@@ -824,20 +957,33 @@ function wp_generate_tag_cloud( $tags, $args = '' ) {
}
/**
- * Callback for comparing objects based on name
+ * Serves as a callback for comparing objects based on name.
+ *
+ * Used with `uasort()`.
*
* @since 3.1.0
* @access private
+ *
+ * @param object $a The first object to compare.
+ * @param object $b The second object to compare.
+ * @return int Negative number if `$a->name` is less than `$b->name`, zero if they are equal,
+ * or greater than zero if `$a->name` is greater than `$b->name`.
*/
function _wp_object_name_sort_cb( $a, $b ) {
return strnatcasecmp( $a->name, $b->name );
}
/**
- * Callback for comparing objects based on count
+ * Serves as a callback for comparing objects based on count.
+ *
+ * Used with `uasort()`.
*
* @since 3.1.0
* @access private
+ *
+ * @param object $a The first object to compare.
+ * @param object $b The second object to compare.
+ * @return bool Whether the count value for `$a` is greater than the count value for `$b`.
*/
function _wp_object_count_sort_cb( $a, $b ) {
return ( $a->count > $b->count );
@@ -853,16 +999,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 );
}
/**
@@ -871,244 +1018,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 );
-}
-
-/**
- * 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
- );
-
- $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'] ) {
- $class .= ' current-cat';
- } elseif ( $category->term_id == $_current_category->parent ) {
- $class .= ' current-cat-parent';
- }
- }
- $output .= ' class="' . $class . '"';
- $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' and 'show_count' keys, if they exist. @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 );
-
- $output .= "\t\n";
}
+ return call_user_func_array( array( $walker, 'walk' ), $args );
}
//
@@ -1142,7 +1062,7 @@ function get_tag_link( $tag ) {
* @since 2.3.0
*
* @param int $id Post ID.
- * @return array|bool Array of tag objects on success, false on failure.
+ * @return array|false|WP_Error Array of tag objects on success, false on failure.
*/
function get_the_tags( $id = 0 ) {
@@ -1167,7 +1087,7 @@ function get_the_tags( $id = 0 ) {
* @param string $sep Optional. Between tags.
* @param string $after Optional. After tags.
* @param int $id Optional. Post ID. Defaults to the current post.
- * @return string|bool|WP_Error A list of tags on success, false if there are no terms, WP_Error on failure.
+ * @return string|false|WP_Error A list of tags on success, false if there are no terms, WP_Error on failure.
*/
function get_the_tag_list( $before = '', $sep = '', $after = '', $id = 0 ) {
@@ -1240,8 +1160,8 @@ function term_description( $term = 0, $taxonomy = 'post_tag' ) {
*
* @param int|object $post Post ID or object.
* @param string $taxonomy Taxonomy name.
- * @return array|bool|WP_Error Array of term objects on success, false if there are no terms
- * or the post does not exist, WP_Error on failure.
+ * @return array|false|WP_Error Array of term objects on success, false if there are no terms
+ * or the post does not exist, WP_Error on failure.
*/
function get_the_terms( $post, $taxonomy ) {
if ( ! $post = get_post( $post ) )
@@ -1250,7 +1170,17 @@ 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');
+ if ( ! is_wp_error( $terms ) ) {
+ $to_cache = array();
+ foreach ( $terms as $key => $term ) {
+ $to_cache[ $key ] = $term->data;
+ }
+ wp_cache_add( $post->ID, $to_cache, $taxonomy . '_relationships' );
+ }
+ }
+
+ if ( ! is_wp_error( $terms ) ) {
+ $terms = array_map( 'get_term', $terms );
}
/**
@@ -1280,7 +1210,7 @@ function get_the_terms( $post, $taxonomy ) {
* @param string $before Optional. Before list.
* @param string $sep Optional. Separate items using this.
* @param string $after Optional. After list.
- * @return string|bool|WP_Error A list of terms on success, false if there are no terms, WP_Error on failure.
+ * @return string|false|WP_Error A list of terms on success, false if there are no terms, WP_Error on failure.
*/
function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = '' ) {
$terms = get_the_terms( $id, $taxonomy );
@@ -1291,24 +1221,27 @@ function get_the_term_list( $id, $taxonomy, $before = '', $sep = '', $after = ''
if ( empty( $terms ) )
return false;
+ $links = array();
+
foreach ( $terms as $term ) {
$link = get_term_link( $term, $taxonomy );
- if ( is_wp_error( $link ) )
+ if ( is_wp_error( $link ) ) {
return $link;
- $term_links[] = '' . $term->name . '';
+ }
+ $links[] = '' . $term->name . '';
}
/**
* Filter the term links for a given taxonomy.
*
- * The dynamic portion of the filter name, $taxonomy, refers
+ * The dynamic portion of the filter name, `$taxonomy`, refers
* to the taxonomy slug.
*
* @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;
}
@@ -1323,7 +1256,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 null|bool 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 );