WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

get_tags()

get_tags( string|array $args = '' ): WP_Term[]|int|WP_Error

In this article

Back to top

Retrieves all post tags.

Parameters

$argsstring|arrayoptional
Arguments to retrieve tags. See get_terms() for additional options.
  • taxonomy string
    Taxonomy to retrieve terms for. Default 'post_tag'.
More Arguments from get_terms( … $args )Array or string of arguments. See WP_Term_Query::__construct() for information on accepted arguments.

Default:''

Return

WP_Term[]|int|WP_Error Array of 'post_tag' term objects, a count thereof, or WP_Error if any of the taxonomies do not exist.

Source

function get_tags( $args = '' ) {
	$defaults = array( 'taxonomy' => 'post_tag' );
	$args     = wp_parse_args( $args, $defaults );

	$tags = get_terms( $args );

	if ( empty( $tags ) ) {
		$tags = array();
	} else {
		/**
		 * Filters the array of term objects returned for the 'post_tag' taxonomy.
		 *
		 * @since 2.3.0
		 *
		 * @param WP_Term[]|int|WP_Error $tags Array of 'post_tag' term objects, a count thereof,
		 *                                     or WP_Error if any of the taxonomies do not exist.
		 * @param array                  $args An array of arguments. See get_terms().
		 */
		$tags = apply_filters( 'get_tags', $tags, $args );
	}

	return $tags;
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘get_tags’, WP_Term[]|int|WP_Error $tags, array $args )

Filters the array of term objects returned for the ‘post_tag’ taxonomy.

UsesDescription
get_terms()wp-includes/taxonomy.php

Retrieves the terms in a given taxonomy or list of taxonomies.

wp_parse_args()wp-includes/functions.php

Merges user defined arguments into defaults array.

apply_filters()wp-includes/plugin.php

Calls the callback functions that have been added to a filter hook.

Show 1 moreShow less
Used byDescription
wp_xmlrpc_server::wp_getTags()wp-includes/class-wp-xmlrpc-server.php

Gets the list of all tags.

Changelog

VersionDescription
2.3.0Introduced.

User Contributed Notes

  1. Skip to note 4 content
    Codex
    You must log in to vote on the helpfulness of this noteVote results for this note: 3You must log in to vote on the helpfulness of this note

    Displays a list of tags with links to each one and a specific class for each tag:

    $tags = get_tags();
$html = '<div class="post_tags">';
foreach ( $tags as $tag ) {
	$tag_link = get_tag_link( $tag->term_id );
			
	$html .= "<a href='{$tag_link}' title='{$tag->name} Tag' class='{$tag->slug}'>";
	$html .= "{$tag->name}</a>";
}
$html .= '</div>';
echo $html;
  3. Skip to note 6 content
    Rubel Miah
    You must log in to vote on the helpfulness of this noteVote results for this note: -3You must log in to vote on the helpfulness of this note

    Display all tags in list format with links.

    $tags = get_tags(array('get'=>'all'));
	$output .= '<ul class="tag-cloud-list">';
		if($tags) {
		foreach ($tags as $tag):
		$output .= '<li><a href="'. get_term_link($tag).'">'. $tag->name .'</a></li>';
		endforeach;
		} else {
		_e('No tags created.', 'text-domain');
		}
	$output .= '</ul>';
return $output;

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