get_terms( string|array $args = array(), array $deprecated = '' )

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

Description
- Parameters
- Return
- Source
- Changelog
Related
- Uses
- Used By
User Contributed Notes

Description Description

You can fully inject any customizations to the query before it is sent, as well as control the output with a filter.

The ‘get_terms’ filter will be called when the cache has the term and will pass the found term along with the array of $taxonomies and array of $args. This filter is also called before the array of terms is passed and will pass the array of terms, along with the $taxonomies and $args.

The ‘list_terms_exclusions’ filter passes the compiled exclusions along with the $args.

The ‘get_terms_orderby’ filter passes the ORDER BY clause for the query along with the $args array.

Prior to 4.5.0, the first parameter of get_terms() was a taxonomy or list of taxonomies:

$terms = get_terms( 'post_tag', array(
    'hide_empty' => false,
) );

Since 4.5.0, taxonomies should be passed via the ‘taxonomy’ argument in the $args array:

$terms = get_terms( array(
    'taxonomy' => 'post_tag',
    'hide_empty' => false,
) );

Parameters Parameters

$args

(string|array) (Optional) Array or string of arguments. See WP_Term_Query::__construct() for information on accepted arguments.

Default value: array()

$deprecated

(array) (Optional) Argument array, when using the legacy function parameter format. If present, this parameter will be interpreted as $args, and the first function parameter will be parsed as a taxonomy or array of taxonomies.

Default value: ''

Top ↑

Return Return

(array|int|WP_Error) List of WP_Term instances and their children. Will return WP_Error, if any of $taxonomies do not exist.

Top ↑

Source Source

File: wp-includes/taxonomy.php

function get_terms( $args = array(), $deprecated = '' ) {
    $term_query = new WP_Term_Query();
 
    $defaults = array(
        'suppress_filter' => false,
    );
 
    /*
     * Legacy argument format ($taxonomy, $args) takes precedence.
     *
     * We detect legacy argument format by checking if
     * (a) a second non-empty parameter is passed, or
     * (b) the first parameter shares no keys with the default array (ie, it's a list of taxonomies)
     */
    $_args          = wp_parse_args( $args );
    $key_intersect  = array_intersect_key( $term_query->query_var_defaults, (array) $_args );
    $do_legacy_args = $deprecated || empty( $key_intersect );
 
    if ( $do_legacy_args ) {
        $taxonomies       = (array) $args;
        $args             = wp_parse_args( $deprecated, $defaults );
        $args['taxonomy'] = $taxonomies;
    } else {
        $args = wp_parse_args( $args, $defaults );
        if ( isset( $args['taxonomy'] ) && null !== $args['taxonomy'] ) {
            $args['taxonomy'] = (array) $args['taxonomy'];
        }
    }
 
    if ( ! empty( $args['taxonomy'] ) ) {
        foreach ( $args['taxonomy'] as $taxonomy ) {
            if ( ! taxonomy_exists( $taxonomy ) ) {
                return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
            }
        }
    }
 
    // Don't pass suppress_filter to WP_Term_Query.
    $suppress_filter = $args['suppress_filter'];
    unset( $args['suppress_filter'] );
 
    $terms = $term_query->query( $args );
 
    // Count queries are not filtered, for legacy reasons.
    if ( ! is_array( $terms ) ) {
        return $terms;
    }
 
    if ( $suppress_filter ) {
        return $terms;
    }
 
    /**
     * Filters the found terms.
     *
     * @since 2.3.0
     * @since 4.6.0 Added the `$term_query` parameter.
     *
     * @param array         $terms      Array of found terms.
     * @param array         $taxonomies An array of taxonomies.
     * @param array         $args       An array of get_terms() arguments.
     * @param WP_Term_Query $term_query The WP_Term_Query object.
     */
    return apply_filters( 'get_terms', $terms, $term_query->query_vars['taxonomy'], $term_query->query_vars, $term_query );
}

Expand full source code Collapse full source code View on Trac

Top ↑

Changelog Changelog

Changelog
Version	Description
4.8.0	Introduced 'suppress_filter' parameter.
4.5.0	Changed the function signature so that the `$args` array can be provided as the first parameter. Introduced 'meta_key' and 'meta_value' parameters. Introduced the ability to order results by metadata.
4.4.0	Introduced the ability to pass 'term_id' as an alias of 'id' for the `orderby` parameter. Introduced the 'meta_query' and 'update_term_meta_cache' parameters. Converted to return a list of WP_Term objects.
4.2.0	Introduced 'name' and 'childless' parameters.
2.3.0	Introduced.

Top ↑

Uses Uses

Uses
Uses	Description
wp-includes/class-wp-term-query.php: WP_Term_Query::__construct()	Constructor.
wp-includes/l10n.php: __()	Retrieve the translation of $text.
wp-includes/functions.php: wp_parse_args()	Merge user defined arguments into defaults array.
wp-includes/taxonomy.php: get_terms	Filters the found terms.
wp-includes/taxonomy.php: taxonomy_exists()	Determines whether the taxonomy name exists.
wp-includes/plugin.php: apply_filters()	Call the functions added to a filter hook.
wp-includes/class-wp-error.php: WP_Error::__construct()	Initialize the error.

Show 2 more uses Hide more uses

Top ↑

Used By Used By

Used By
Used By	Description
wp-admin/includes/post.php: taxonomy_meta_box_sanitize_cb_input()	Sanitizes POST values from an input taxonomy metabox.
wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php: WP_REST_Terms_Controller::get_items()	Retrieves terms associated with a taxonomy.
wp-includes/class-wp-term-query.php: WP_Term_Query::get_terms()	Get terms, based on query_vars.
wp-includes/class-wp-customize-nav-menus.php: WP_Customize_Nav_Menus::search_available_items_query()	Performs post queries for available-item searching.
wp-includes/class-wp-customize-nav-menus.php: WP_Customize_Nav_Menus::load_available_items_query()	Performs the post_type and taxonomy queries for loading available menu items.
wp-admin/includes/export.php: export_wp()	Generates the WXR export file for download.
wp-admin/includes/template.php: wp_terms_checklist()	Output an unordered list of checkbox input elements labelled with term names.
wp-admin/includes/template.php: wp_popular_terms_checklist()	Retrieve a list of the most popular terms from the specified taxonomy.
wp-admin/includes/template.php: wp_link_category_checklist()	Outputs a link category checklist element.
wp-admin/includes/ajax-actions.php: wp_ajax_get_tagcloud()	Ajax handler for getting a tagcloud.
wp-admin/includes/ajax-actions.php: wp_ajax_ajax_tag_search()	Ajax handler for tag search.
wp-admin/includes/class-wp-terms-list-table.php: WP_Terms_List_Table::display_rows_or_placeholder()
wp-admin/includes/nav-menu.php: _wp_ajax_menu_quick_search()	Prints the appropriate response to a menu quick search.
wp-admin/includes/nav-menu.php: wp_nav_menu_item_taxonomy_meta_box()	Displays a meta box for a taxonomy menu item.
wp-includes/class-walker-category.php: Walker_Category::start_el()	Starts the element output.
wp-includes/category-template.php: wp_tag_cloud()	Displays a tag cloud.
wp-includes/category-template.php: wp_dropdown_categories()	Display or retrieve the HTML dropdown list of categories.
wp-includes/category.php: get_tags()	Retrieves all post tags.
wp-includes/category.php: get_categories()	Retrieve list of category objects.
wp-includes/category.php: get_category_by_path()	Retrieve category based on URL containing the category slug.
wp-includes/deprecated.php: get_all_category_ids()	Retrieves all category IDs.
wp-includes/widgets/class-wp-widget-links.php: WP_Widget_Links::form()	Outputs the settings form for the Links widget.
wp-includes/taxonomy.php: wp_get_object_terms()	Retrieves the terms associated with the given object(s), in the supplied taxonomies.
wp-includes/taxonomy.php: wp_insert_term()	Add a new term to the database.
wp-includes/taxonomy.php: wp_count_terms()	Count how many terms are in Taxonomy.
wp-includes/taxonomy.php: get_term_by()	Get all Term data from database by Term field and data.
wp-includes/bookmark-template.php: wp_list_bookmarks()	Retrieve or echo all of the bookmarks.
wp-includes/nav-menu.php: wp_get_nav_menus()	Returns all navigation menu objects.
wp-includes/nav-menu.php: wp_get_nav_menu_items()	Retrieves all menu items of a navigation menu.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::wp_getTerms()	Retrieve all terms for a taxonomy.
wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::_insert_post()	Helper method for wp_newPost() and wp_editPost(), containing shared logic.

Show 26 more used by Hide more used by

Top ↑

User Contributed Notes User Contributed Notes

Contributed by kopernik1elfka — 2 years ago

All get_terms attributes with default values:
(I try default from this article and it didn’t work. This works.)

$get_terms_default_attributes = array (
            'taxonomy' => 'category', //empty string(''), false, 0 don't work, and return empty array
            'orderby' => 'name',
            'order' => 'ASC',
            'hide_empty' => true, //can be 1, '1' too
            'include' => 'all', //empty string(''), false, 0 don't work, and return empty array
            'exclude' => 'all', //empty string(''), false, 0 don't work, and return empty array
            'exclude_tree' => 'all', //empty string(''), false, 0 don't work, and return empty array
            'number' => false, //can be 0, '0', '' too
            'offset' => '',
            'fields' => 'all',
            'name' => '',
            'slug' => '',
            'hierarchical' => true, //can be 1, '1' too
            'search' => '',
            'name__like' => '',
            'description__like' => '',
            'pad_counts' => false, //can be 0, '0', '' too
            'get' => '',
            'child_of' => false, //can be 0, '0', '' too
            'childless' => false,
            'cache_domain' => 'core',
            'update_term_meta_cache' => true, //can be 1, '1' too
            'meta_query' => '',
            'meta_key' => array(),
            'meta_value'=> '',
    );

Expand full source code Collapse full source code

Contributed by ancawonka — 3 years ago

As of WordPress 4.6.1, here’s the array that’s returned (to add to Leo’s helpful note above)

array(1) {
  [0]=&gt;
  object(WP_Term) (11) {
    ["term_id"]=&gt;  //int
    ["name"]=&gt;   //string 
    ["slug"]=&gt;  //string 
    ["term_group"]=&gt;  //int
    ["term_taxonomy_id"]=&gt; //int
    ["taxonomy"]=&gt;   //string
    ["description"]=&gt;    //string
    ["parent"]=&gt; //int
    ["count"]=&gt;  // int
    ["filter"]=&gt; //string
    ["meta"]=&gt; array(0) { // presumably this would be some returned meta-data?
    }
  }
}

Expand full source code Collapse full source code

Skip to note 3 content

You must log in to vote on the helpfulness of this noteVote results for this note: 8You must log in to vote on the helpfulness of this note

Contributed by mitch827 — 3 years ago

If parent => 0 is passed, only top-level terms will be returned

1
2
3
4
$terms = get_terms( array(
'taxonomy' => 'tax_name',
'parent' => 0
) );

Log in to add feedback

Log in to add feedback
Skip to note 4 content

You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note

Contributed by Siobhan — 5 years ago

Get all post categories ordered by count.

String syntax:

1
$categories = get_terms( 'category', 'orderby=count&hide_empty=0' );

Array syntax:

1
2
3
4
$categories = get_terms( 'category', array(
'orderby' => 'count',
'hide_empty' => 0
) );

Log in to add feedback

Log in to add feedback

Contributed by znowebdev — 4 years ago

Get all post categories ordered by count.

String syntax:

1	`$categories` `= get_terms(` `'category',` `'orderby=count&hide_empty=0'` `);`

Array syntax:

$categories = get_terms( 'category', array(
    'orderby'    => 'count',
    'hide_empty' => 0,
) );

Get all the links categories:

$my_links_categories = get_terms( 'link_category', 'orderby=count&hide_empty=0' );

List all the terms in a custom taxonomy, without a link:

$terms = get_terms( 'my_taxonomy' );
if ( ! empty( $terms ) && ! is_wp_error( $terms ) ){
    echo '<ul>';
    foreach ( $terms as $term ) {
        echo '<li>' . $term->name . '</li>';
    }
    echo '</ul>';
}

List all the terms, with link to term archive, separated by an interpunct (·):

$args = array( 'hide_empty=0' );
 
$terms = get_terms( 'my_term', $args );
if ( ! empty( $terms ) && ! is_wp_error( $terms ) ) {
    $count = count( $terms );
    $i = 0;
    $term_list = '<p class="my_term-archive">';
    foreach ( $terms as $term ) {
        $i++;
        $term_list .= '<a href="' . esc_url( get_term_link( $term ) ) . '" alt="' . esc_attr( sprintf( __( 'View all post filed under %s', 'my_localization_domain' ), $term->name ) ) . '">' . $term->name . '</a>';
        if ( $count != $i ) {
            $term_list .= ' &middot; ';
        }
        else {
            $term_list .= '</p>';
        }
    }
    echo $term_list;
}

Expand full source code Collapse full source code

Contributed by CdWritted — 2 years ago

Get categories and subcategories by custom taxonomies:

$taxonomies = get_terms( array(
    'taxonomy' => 'taxonomy_name',
    'hide_empty' => false
) );
 
if ( !empty($taxonomies) ) :
    $output = '<select>';
    foreach( $taxonomies as $category ) {
        if( $category->parent == 0 ) {
            $output.= '<optgroup label="'. esc_attr( $category->name ) .'">';
            foreach( $taxonomies as $subcategory ) {
                if($subcategory->parent == $category->term_id) {
                $output.= '<option value="'. esc_attr( $subcategory->term_id ) .'">
                    '. esc_html( $subcategory->name ) .'</option>';
                }
            }
            $output.='</optgroup>';
        }
    }
    $output.='</select>';
    echo $output;
endif;

Expand full source code Collapse full source code

Contributed by Kevin — 2 years ago

Working with Advanced Custom Fields (field type: Taxonomy, output: Object) for filtering taxonomies.

Case: Create a filter with main categories defined by ACF field, and all another should belongs to *others*.

Solution:

// Define Featured Category IDs first
$featured_category_ids = array();
// It must be output WP_Object
$featured_categories = get_field('main_category_filters');
 
// Creating loop to insert IDs to array.
foreach( $featured_categories as $cat ) {
    $featured_category_ids[] = $cat-&gt;term_id;
}
 
// Now, if Featured Categories are match, add their IDs via 'exclude'
if( $featured_categories ) {
    $args = array(
        'taxonomy' =&gt; 'event_cat',
        'parent' =&gt; 0,
        'exclude' =&gt; $featured_category_ids
    );
} else {
    // If no featured, just display all terms
    $args = array(
        'taxonomy' =&gt; 'event_cat',
        'parent' =&gt; 0
    );
}
 
// Starting query terms now
$other_categories = get_terms($args);

Expand full source code Collapse full source code

Skip to note 8 content

You must log in to vote on the helpfulness of this noteVote results for this note: 2You must log in to vote on the helpfulness of this note

Contributed by rezapr2 — 3 years ago

List terms limit to those matching a specific metadata key and metadata value

1
2
3
4
5
$terms= get_terms( array(
    'taxonomy' => 'taxonomy name',
    'meta_key' => 'metadata key',
    'meta_value' => 'metadata value'
) );

Log in to add feedback

Log in to add feedback
Skip to note 9 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 kalor — 2 years ago

Order by parent term ID – not documented, but also works.

1
2
3
$categories = get_terms( 'category', array(
'orderby' => 'parent',
) );

Log in to add feedback

Log in to add feedback

Contributed by ctousignant — 1 year ago

Meta Query using a custom field, and then ordering using a different custom field.

$terms = get_terms( array(
    'taxonomy' => 'tax_slug',
    'hide_empty' => false,
    'meta_query' => array(
        [
            'key' => 'meta_key_slug_1',
            'value' => 'desired value to look for'
        ]
    ),
    'meta_key' => 'meta_key_slug_2',
    'orderby' => 'meta_key_slug_2'
 
) );

Expand full source code Collapse full source code

-3

Contributed by Anvar Ulugov — 2 years ago

Get Terms filtered by first letter

$authors = get_terms('book-authors', array('name__like' => $first_l));
 
function custom_tax_query( $pieces, $taxonomies, $args ) {
  if ( 'book-authors' == $taxonomies[0] ) {
    $pieces['where'] = str_replace("LIKE '%", "LIKE '", $pieces['where']);
  }
return $pieces;
}

Skip to note 12 content

You must log in to vote on the helpfulness of this noteVote results for this note: -4You must log in to vote on the helpfulness of this note

Contributed by Asgaros — 2 years ago

Get terms ordered by value of meta-key:

1
2
3
4
5
6
7
$terms = get_terms(
    'taxonomy_name',
    array(
        'meta_key' => 'custom_meta_key',
        'orderby' => 'custom_meta_key'
    )
);

Log in to add feedback

Log in to add feedback

-14

Contributed by Kevin — 3 years ago

Get Categories by custom post type with dropdown:

function taxonomy_list_dropdown($type, $post_type) {
  $terms = get_terms($type);
  $category = taxonomy_current($type);
 
  if ( !empty( $terms ) &amp;&amp; !is_wp_error( $terms ) ){
    the_terms_list(
      'categories__dropdown icon-dropdown',
      array(
        'show_option_all'  =&gt; 'Click to filter',
        'taxonomy'         =&gt; $type,
        'current_category' =&gt; $category-&gt;term_id,
        'value_field'      =&gt; 'slug',
        'selected'         =&gt; $category-&gt;slug,
      ),
      'dropdown',
      'data-module-init="redirect-dropdown"'
    );
  }
}

Expand full source code Collapse full source code

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

WordPress.org

Code Reference

get_terms( string|array $args = array(), array $deprecated = '' )

Contents

Description Description

Parameters Parameters

Return Return

Source Source

Changelog Changelog

User Contributed Notes User Contributed Notes

WordPress.org

get_terms( string|array $args = array(), array $deprecated = '' )

Contents

Description #Description

Parameters #Parameters

Return #Return

Source #Source

Changelog #Changelog

Related #Related

Uses #Uses

Used By #Used By

User Contributed Notes #User Contributed Notes

Description Description

Parameters Parameters

Return Return

Source Source

Changelog Changelog

Related Related

Uses Uses

Used By Used By

User Contributed Notes User Contributed Notes