wp_tag_cloud() WordPress Function

The wp_tag_cloud() function is a versatile function that can be used to display a tag cloud in your WordPress site. This function can be used to display a tag cloud in your sidebar, in your posts, or in your pages. The wp_tag_cloud() function can be used to display a tag cloud in your WordPress site. This function can be used to display a tag cloud in your sidebar, in your posts, or in your pages. The wp_tag_cloud() function takes two parameters: the first is thetaxonomy that you want to display the tag cloud for; the second is theargs array. The taxonomy can be one of the following: 'post_tag', 'link_category', 'category', or 'post_format'. The args array can be used to specify how the tag cloud should be displayed. For example, you can use the args array to specify the number of tags to display, the order in which the tags should be displayed, the format of the tag cloud, and whether to show the tag cloud in your sidebar, in your posts, or in your pages.

wp_tag_cloud( array|string $args = '' ) #

Displays a tag cloud.


Description

Outputs a list of tags in what is called a ‘tag cloud’, where the size of each tag is determined by how many times that particular tag has been assigned to posts.


Top ↑

Parameters

$args

(array|string)(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.

  • 'number'
    (int) The number of tags to display. Accepts any positive integer or zero to return all. Default 45.
  • 'link'
    (string) Whether to display term editing links or term permalinks. Accepts 'edit' and 'view'. Default 'view'.
  • 'post_type'
    (string) 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.
  • 'echo'
    (bool) Whether or not to echo the return value. Default true.

Default value: ''


Top ↑

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.


Top ↑

Source

File: wp-includes/category-template.php

function wp_tag_cloud( $args = '' ) {
	$defaults = array(
		'smallest'   => 8,
		'largest'    => 22,
		'unit'       => 'pt',
		'number'     => 45,
		'format'     => 'flat',
		'separator'  => "\n",
		'orderby'    => 'name',
		'order'      => 'ASC',
		'exclude'    => '',
		'include'    => '',
		'link'       => 'view',
		'taxonomy'   => 'post_tag',
		'post_type'  => '',
		'echo'       => true,
		'show_count' => 0,
	);

	$args = wp_parse_args( $args, $defaults );

	$tags = get_terms(
		array_merge(
			$args,
			array(
				'orderby' => 'count',
				'order'   => 'DESC',
			)
		)
	); // Always query top tags.

	if ( empty( $tags ) || is_wp_error( $tags ) ) {
		return;
	}

	foreach ( $tags as $key => $tag ) {
		if ( 'edit' === $args['link'] ) {
			$link = get_edit_term_link( $tag, $tag->taxonomy, $args['post_type'] );
		} else {
			$link = get_term_link( $tag, $tag->taxonomy );
		}

		if ( is_wp_error( $link ) ) {
			return;
		}

		$tags[ $key ]->link = $link;
		$tags[ $key ]->id   = $tag->term_id;
	}

	// Here's where those top tags get sorted according to $args.
	$return = wp_generate_tag_cloud( $tags, $args );

	/**
	 * Filters the tag cloud output.
	 *
	 * @since 2.3.0
	 *
	 * @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. 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;
	}

	echo $return;
}


Top ↑

Changelog

Changelog
VersionDescription
4.8.0Added the show_count argument.
2.8.0Added the taxonomy argument.
2.3.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.