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

Description

Parameters

$argsarray|stringoptional

Array or string of arguments. See WP_Term_Query::__construct() for information on accepted arguments. Default empty array.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 empty.Default: ''

Return

string|WP_Error

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

Uses · 4

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

Used by · 5

• WP_REST_Term_Search_Handler::search_items()Searches terms for a given search request.
• WP_REST_Terms_Controller::get_items()Retrieves terms associated with a taxonomy.
• WP_Sitemaps_Taxonomies::get_max_num_pages()Gets the max number of pages available for the object type.
• WP_Terms_List_Table::prepare_items()
• wp_nav_menu_item_taxonomy_meta_box()Displays a meta box for a taxonomy menu item.

Source

View on Trac ↗View on GitHub ↗

1944function wp_count_terms( $args = array(), $deprecated = '' ) {1945	$use_legacy_args = false;1946 1947	// Check whether function is used with legacy signature: `$taxonomy` and `$args`.1948	if ( $args1949		&& ( is_string( $args ) && taxonomy_exists( $args )1950			|| is_array( $args ) && wp_is_numeric_array( $args ) )1951	) {1952		$use_legacy_args = true;1953	}1954 1955	$defaults = array( 'hide_empty' => false );1956 1957	if ( $use_legacy_args ) {1958		$defaults['taxonomy'] = $args;1959		$args                 = $deprecated;1960	}1961 1962	$args = wp_parse_args( $args, $defaults );1963 1964	// Backward compatibility.1965	if ( isset( $args['ignore_empty'] ) ) {1966		$args['hide_empty'] = $args['ignore_empty'];1967		unset( $args['ignore_empty'] );1968	}1969 1970	$args['fields'] = 'count';1971 1972	return get_terms( $args );1973}

History

Introduced in 2.3.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.8.8 tag, from src/wp-includes/taxonomy.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.