enmi-conf.org: comparison wp/wp-includes/category-template.php

equal deleted inserted replaced

-:34716fd837a4
+:be944660c56a
 * Conditional Tags} article in the Theme Developer Handbook.
 *
 * @since 1.2.0
 * @since 2.7.0 The `$post` parameter was added.
 *
-* @param int|string|array $category Category ID, name or slug, or array of said.
+* @param int|string|int[]|string[] $category Category ID, name, slug, or array of such
-* @param int|object       $post     Optional. Post to check instead of the current post.
+*                                            to check against.
+* @param int|object                $post     Optional. Post to check instead of the current post.
 * @return bool True if the current post is in any of the given categories.
 */
 function in_category( $category, $post = null ) {
 	if ( empty( $category ) ) {
 		return false;
 *     @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|array $taxonomy          Name of the category or categories to retrieve. Default 'category'.
+*     @type string|array $taxonomy          Name of the taxonomy or taxonomies 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).
 *     @type bool         $required          Whether the `<select>` element should have the HTML5 'required' attribute.
 *                                           Default false.
 * }
 		if ( $parsed_args['show_option_all'] ) {
 			/** This filter is documented in wp-includes/category-template.php */
 			$show_option_all = apply_filters( 'list_cats', $parsed_args['show_option_all'], null );
-			$selected        = ( '0' === strval( $parsed_args['selected'] ) ) ? " selected='selected'" : '';
+			$selected        = ( '0' === (string) $parsed_args['selected'] ) ? " selected='selected'" : '';
 			$output         .= "\t<option value='0'$selected>$show_option_all</option>\n";
 		}
 		if ( $parsed_args['show_option_none'] ) {
 *
 * @param array|string $args {
 *     Array of optional arguments. See get_categories(), get_terms(), and WP_Term_Query::__construct()
 *     for information on additional accepted arguments.
 *
-*     @type int|array    $current_category      ID of category, or array of IDs of categories, that should get the
+*     @type int|int[]    $current_category      ID of category, or array of IDs of categories, that should get the
 *                                               'current-cat' class. Default 0.
 *     @type int          $depth                 Category depth. Used for tab indentation. Default 0.
 *     @type bool|int     $echo                  Whether to echo or return the generated markup. Accepts 0, 1, or their
 *                                               bool equivalents. Default 1.
-*     @type array|string $exclude               Array or comma/space-separated string of term IDs to exclude.
+*     @type int[]|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 get_terms().
 *                                               Default empty string.
-*     @type array|string $exclude_tree          Array or comma/space-separated string of term IDs to exclude, along
+*     @type int[]|string $exclude_tree          Array or comma/space-separated string of term IDs to exclude, along
 *                                               with their descendants. See get_terms(). Default empty string.
 *     @type string       $feed                  Text to use for the feed link. Default 'Feed for all posts filed
 *                                               under [cat name]'.
 *     @type string       $feed_image            URL of an image to use for the feed link. Default empty string.
 *     @type string       $feed_type             Feed type. Used to build feed link. See get_term_feed_link().
 *     @type string       $show_option_none      Text to display for the 'no categories' option.
 *                                               Default 'No categories'.
 *     @type string       $style                 The style used to display the categories list. If 'list', categories
 *                                               will be output as an unordered list. If left empty or another value,
 *                                               categories will be output separated by `<br>` tags. Default 'list'.
+*     @type string       $taxonomy              Name of the taxonomy to retrieve. Default 'category'.
 *     @type string       $title_li              Text to use for the list title `<li>` element. Pass an empty string
 *                                               to disable. Default 'Categories'.
 *     @type bool|int     $use_desc_for_title    Whether to use the category description as the title attribute.
 *                                               Accepts 0, 1, or their bool equivalents. Default 1.
 * }
 	 * Filters the HTML output of a taxonomy list.
 	 *
 	 * @since 2.1.0
 	 *
 	 * @param string $output HTML output.
-	 * @param array  $args   An array of taxonomy-listing arguments.
+	 * @param array  $args   An array of taxonomy-listing arguments. See wp_list_categories()
+	 *                       for information on accepted arguments.
 	 */
 	$html = apply_filters( 'wp_list_categories', $output, $args );
 	if ( $parsed_args['echo'] ) {
 		echo $html;
 * @param array|string $args {
 *     Optional. Array or string of arguments for displaying a tag cloud. See wp_generate_tag_cloud()
 *     and get_terms() for the full lists of arguments that can be passed in `$args`.
 *
 *     @type int    $number    The number of tags to display. Accepts any positive integer
-*                             or zero to return all. Default 0 (all tags).
+*                             or zero to return all. Default 45.
 *     @type string $link      Whether to display term editing links or term permalinks.
 *                             Accepts 'edit' and 'view'. Default 'view'.
 *     @type string $post_type The post type. Used to highlight the proper post type menu
 *                             on the linked edit page. Defaults to the first post type
 *                             associated with the taxonomy.
 *     @type bool   $echo      Whether or not to echo the return value. Default true.
 * }
-* @return void|string|array Void if 'echo' argument is true, or on failure. Otherwise, tag cloud
+* @return void|string|string[] Void if 'echo' argument is true, or on failure. Otherwise, tag cloud
-*                           as a string or an array, depending on 'format' argument.
+*                              as a string or an array, depending on 'format' argument.
 */
 function wp_tag_cloud( $args = '' ) {
 	$defaults = array(
 		'smallest'   => 8,
 		'largest'    => 22,
 	foreach ( $tags as $key => $tag ) {
 		if ( 'edit' === $args['link'] ) {
 			$link = get_edit_term_link( $tag->term_id, $tag->taxonomy, $args['post_type'] );
 		} else {
-			$link = get_term_link( intval( $tag->term_id ), $tag->taxonomy );
+			$link = get_term_link( (int) $tag->term_id, $tag->taxonomy );
 		}
 		if ( is_wp_error( $link ) ) {
 			return;
 		}
 	/**
 	 * Filters the tag cloud output.
 	 *
 	 * @since 2.3.0
 	 *
-	 * @param string|array $return Tag cloud as a string or an array, depending on 'format' argument.
+	 * @param string|string[] $return Tag cloud as a string or an array, depending on 'format' argument.
-	 * @param array        $args   An array of tag cloud arguments.
+	 * @param array           $args   An array of tag cloud arguments. See wp_tag_cloud()
+	 *                                for information on accepted arguments.
 	 */
 	$return = apply_filters( 'wp_tag_cloud', $return, $args );
 	if ( 'array' === $args['format'] || empty( $args['echo'] ) ) {
 		return $return;
 *                                                Default 'name'. The {@see 'tag_cloud_sort'} filter
 *                                                can also affect how tags are sorted.
 *     @type string   $order                      How to order the tags. Accepts 'ASC' (ascending),
 *                                                'DESC' (descending), or 'RAND' (random). Default 'ASC'.
 *     @type int|bool $filter                     Whether to enable filtering of the final output
-*                                                via {@see 'wp_generate_tag_cloud'}. Default 1|true.
+*                                                via {@see 'wp_generate_tag_cloud'}. Default 1.
 *     @type string   $topic_count_text           Nooped plural text from _n_noop() to supply to
 *                                                tag counts. Default null.
 *     @type callable $topic_count_text_callback  Callback used to generate nooped plural text for
 *                                                tag counts based on the count. Default null.
 *     @type callable $topic_count_scale_callback Callback used to determine the tag count scaling
 *                                                value. Default default_topic_count_scale().
 *     @type bool|int $show_count                 Whether to display the tag counts. Default 0. Accepts
 *                                                0, 1, or their bool equivalents.
 * }
-* @return string|array Tag cloud as a string or an array, depending on 'format' argument.
+* @return string|string[] Tag cloud as a string or an array, depending on 'format' argument.
 */
 function wp_generate_tag_cloud( $tags, $args = '' ) {
 	$defaults = array(
 		'smallest'                   => 8,
 		'largest'                    => 22,
 	/**
 	 * Filters 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.
+	 * @param array[] $tags_data An array of term data arrays for terms used to generate the tag cloud.
 	 */
 	$tags_data = apply_filters( 'wp_generate_tag_cloud_data', $tags_data );
 	$a = array();
 			 * Force role="list", as some browsers (sic: Safari 10) don't expose to assistive
 			 * technologies the default role when the list is styled with `list-style: none`.
 			 * Note: this is redundant but doesn't harm.
 			 */
 			$return  = "<ul class='wp-tag-cloud' role='list'>\n\t<li>";
-			$return .= join( "</li>\n\t<li>", $a );
+			$return .= implode( "</li>\n\t<li>", $a );
 			$return .= "</li>\n</ul>\n";
 			break;
 		default:
-			$return = join( $args['separator'], $a );
+			$return = implode( $args['separator'], $a );
 			break;
 	}
 	if ( $args['filter'] ) {
 		/**
 		 *
 		 * @since 2.3.0
 		 *
 		 * @see wp_generate_tag_cloud()
 		 *
-		 * @param array|string $return String containing the generated HTML tag cloud output
+		 * @param string[]|string $return String containing the generated HTML tag cloud output
-		 *                             or an array of tag links if the 'format' argument
+		 *                                or an array of tag links if the 'format' argument
-		 *                             equals 'array'.
+		 *                                equals 'array'.
-		 * @param WP_Term[]    $tags   An array of terms used in the tag cloud.
+		 * @param WP_Term[]       $tags   An array of terms used in the tag cloud.
-		 * @param array        $args   An array of wp_generate_tag_cloud() arguments.
+		 * @param array           $args   An array of wp_generate_tag_cloud() arguments.
 		 */
 		return apply_filters( 'wp_generate_tag_cloud', $return, $tags, $args );
 	} else {
 		return $return;
 	}
 /**
 * Retrieves the tags for a post.
 *
 * @since 2.3.0
 *
-* @param int $post_id Post ID.
+* @param int|WP_Post $post_id Post ID or object.
-* @return array|false|WP_Error Array of tag objects on success, false on failure.
+* @return WP_Term[]|false|WP_Error Array of WP_Term objects on success, false if there are no terms
+*                                  or the post does not exist, WP_Error on failure.
 */
 function get_the_tags( $post_id = 0 ) {
 	$terms = get_the_terms( $post_id, 'post_tag' );
 	/**
 	 *
 	 * @since 2.3.0
 	 *
 	 * @see get_the_terms()
 	 *
-	 * @param WP_Term[] $terms An array of tags for the given post.
+	 * @param WP_Term[]|false|WP_Error $terms Array of WP_Term objects on success, false if there are no terms
+	 *                                        or the post does not exist, WP_Error on failure.
 	 */
 	return apply_filters( 'get_the_tags', $terms );
 }
 /**
 	 *
 	 * @param string[] $links An array of term links.
 	 */
 	$term_links = apply_filters( "term_links-{$taxonomy}", $links );  // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores
-	return $before . join( $sep, $term_links ) . $after;
+	return $before . implode( $sep, $term_links ) . $after;
 }
 /**
 * Retrieves term parents with separator.
 *

changeset 18	be944660c56a
parent 16	a86126ab1dd4
child 19	3d72ae0968f4