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

Count how many terms are in Taxonomy.


Description Description

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


Top ↑

Parameters Parameters

$args

(array|string) (Optional) Array of arguments that get passed to get_terms().

Default value: array()

$deprecated

(array|string) (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) Number of terms in that taxonomy or WP_Error if the taxonomy does not exist.


Top ↑

Source Source

File: wp-includes/taxonomy.php

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 );
}


Top ↑

Changelog Changelog

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.

Top ↑

User Contributed Notes User Contributed Notes

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