wp_tag_cloud( array|string $args = '' )

Displays a tag cloud.

Contents

Description 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 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 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 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->term_id, $tag->taxonomy, $args['post_type'] );
		} else {
			$link = get_term_link( (int) $tag->term_id, $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;
}

Expand full source code Collapse full source code View on Trac

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/category-template.php: wp_generate_tag_cloud()

Generates a tag cloud (heatmap) from provided data.
wp-includes/category-template.php: wp_tag_cloud

Filters the tag cloud output.
wp-includes/functions.php: wp_parse_args()

Merges user defined arguments into defaults array.
wp-includes/taxonomy.php: get_term_link()

Generate a permalink for a taxonomy term archive.
wp-includes/taxonomy.php: get_terms()

Retrieves the terms in a given taxonomy or list of taxonomies.
wp-includes/link-template.php: get_edit_term_link()

Retrieves the URL for editing a given term.
wp-includes/plugin.php: apply_filters()

Calls the callback functions that have been added to a filter hook.
wp-includes/load.php: is_wp_error()

Checks whether the given variable is a WordPress Error.
Show 3 more uses Hide more uses

Top ↑

Changelog Changelog

Changelog
Version Description
4.8.0 Added the show_count argument.
2.8.0 Added the taxonomy argument.
2.3.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

  6. Skip to note 6 content
    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note
    Contributed by Codex —

    Change Title Text of Cloud Links

    Use the topic_count_text_callback argument to pass in a new callback function. The original function default_topic_count_text() is located in /wp-includes/category-template.php This example changes the title text from the default “topics” to “pictures”.

    <?php 
	wp_tag_cloud( array( 'topic_count_text_callback' => 'my_tag_text_callback' ) ); 

	function my_tag_text_callback( $count ) {
		return sprintf( _n( '%s picture', '%s pictures', $count ), number_format_i18n( $count ) );
	}
?>

You must log in before being able to contribute a note or feedback.