WC_API_Products::get_products_count()publicWC 2.1

Get the total number of products

Method of the class: WC_API_Products{}

No Hooks.

Return

Array|WP_Error.

Usage

$WC_API_Products = new WC_API_Products();
$WC_API_Products->get_products_count( $type, $filter );
$type(string)
-
Default: null
$filter(array)
-
Default: array()

Changelog

Since 2.1 Introduced.

WC_API_Products::get_products_count() code WC 8.9.0

public function get_products_count( $type = null, $filter = array() ) {
	try {
		if ( ! current_user_can( 'read_private_products' ) ) {
			throw new WC_API_Exception( 'woocommerce_api_user_cannot_read_products_count', __( 'You do not have permission to read the products count', 'woocommerce' ), 401 );
		}

		if ( ! empty( $type ) ) {
			$filter['type'] = $type;
		}

		$query = $this->query_products( $filter );

		return array( 'count' => (int) $query->found_posts );
	} catch ( WC_API_Exception $e ) {
		return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
	}
}