WC_API_Products::get_product_tags( string|null $fields = null )
Get a listing of product tags.
Description Description
Parameters Parameters
- $fields
-
(Optional) Fields to limit response to
Default value: null
Return Return
(array|WP_Error)
Source Source
File: includes/legacy/api/v3/class-wc-api-products.php
public function get_product_tags( $fields = null ) { try { // Permissions check if ( ! current_user_can( 'manage_product_terms' ) ) { throw new WC_API_Exception( 'woocommerce_api_user_cannot_read_product_tags', __( 'You do not have permission to read product tags', 'woocommerce' ), 401 ); } $product_tags = array(); $terms = get_terms( 'product_tag', array( 'hide_empty' => false, 'fields' => 'ids' ) ); foreach ( $terms as $term_id ) { $product_tags[] = current( $this->get_product_tag( $term_id, $fields ) ); } return array( 'product_tags' => apply_filters( 'woocommerce_api_product_tags_response', $product_tags, $terms, $fields, $this ) ); } catch ( WC_API_Exception $e ) { return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) ); } }
Changelog Changelog
Version | Description |
---|---|
2.5.0 | Introduced. |