wp_count_terms( array|string $args = array(), array|string $deprecated = '' ): string|WP_Error

Counts how many terms are in taxonomy.

Description

Default $args is ‘hide_empty’ which can be ‘hide_empty=true’ or array(‘hide_empty’ => true).

{@internal The $deprecated parameter is parsed for backward compatibility only.}

Parameters

$argsarray|stringoptional

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

Default:array()

$deprecatedarray|stringoptional

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:''

Return

string|WP_Error Numeric string containing the number of terms in that taxonomy or WP_Error if the taxonomy does not exist.

Source

function wp_count_terms( $args = array(), $deprecated = '' ) {
	$use_legacy_args = false;

	// Check whether function is used with legacy signature: `$taxonomy` and `$args`.
	if ( $args
		&& ( is_string( $args ) && taxonomy_exists( $args )
			|| is_array( $args ) && wp_is_numeric_array( $args ) )
	) {
		$use_legacy_args = true;
	}

	$defaults = array( 'hide_empty' => false );

	if ( $use_legacy_args ) {
		$defaults['taxonomy'] = $args;
		$args                 = $deprecated;
	}

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

	// Backward compatibility.
	if ( isset( $args['ignore_empty'] ) ) {
		$args['hide_empty'] = $args['ignore_empty'];
		unset( $args['ignore_empty'] );
	}

	$args['fields'] = 'count';

	return get_terms( $args );
}

View all references View on Trac View on GitHub

Related

Uses	Description
wp_is_numeric_array()wp-includes/functions.php	Determines if the variable is a numeric-indexed array.
get_terms()wp-includes/taxonomy.php	Retrieves the terms in a given taxonomy or list of taxonomies.
taxonomy_exists()wp-includes/taxonomy.php	Determines whether the taxonomy name exists.
wp_parse_args()wp-includes/functions.php	Merges user defined arguments into defaults array.

Show 1 moreShow less

Used by	Description
WP_REST_Term_Search_Handler::search_items()wp-includes/rest-api/search/class-wp-rest-term-search-handler.php	Searches terms for a given search request.
WP_Sitemaps_Taxonomies::get_max_num_pages()wp-includes/sitemaps/providers/class-wp-sitemaps-taxonomies.php	Gets the max number of pages available for the object type.
WP_REST_Terms_Controller::get_items()wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php	Retrieves terms associated with a taxonomy.
WP_Terms_List_Table::prepare_items()wp-admin/includes/class-wp-terms-list-table.php
wp_nav_menu_item_taxonomy_meta_box()wp-admin/includes/nav-menu.php	Displays a meta box for a taxonomy menu item.

Changelog

Version	Description
5.6.0	Changed the function signature so that the $args array can be provided as the first parameter.
2.3.0	Introduced.