WC_API_Products::get_product_attribute_terms() public WC 2.5.0
Get a listing of product attribute terms.
{} It's a method of the class: WC_API_Products{}
Hooks from the method
Return
Array|WP_Error.
Usage
$WC_API_Products = new WC_API_Products(); $WC_API_Products->get_product_attribute_terms( $attribute_id, $fields );
- $attribute_id(int) (required)
- Attribute ID.
- $fields(string|null)
- Fields to limit response to.
Changelog
Since 2.5.0 | Introduced. |
Code of WC_API_Products::get_product_attribute_terms() WC API Products::get product attribute terms WC 5.0.0
public function get_product_attribute_terms( $attribute_id, $fields = null ) {
try {
// Permissions check.
if ( ! current_user_can( 'manage_product_terms' ) ) {
throw new WC_API_Exception( 'woocommerce_api_user_cannot_read_product_attribute_terms', __( 'You do not have permission to read product attribute terms', 'woocommerce' ), 401 );
}
$attribute_id = absint( $attribute_id );
$taxonomy = wc_attribute_taxonomy_name_by_id( $attribute_id );
if ( ! $taxonomy ) {
throw new WC_API_Exception( 'woocommerce_api_invalid_product_attribute_id', __( 'A product attribute with the provided ID could not be found', 'woocommerce' ), 404 );
}
$terms = get_terms( $taxonomy, array( 'hide_empty' => false ) );
$attribute_terms = array();
foreach ( $terms as $term ) {
$attribute_terms[] = array(
'id' => $term->term_id,
'slug' => $term->slug,
'name' => $term->name,
'count' => $term->count,
);
}
return array( 'product_attribute_terms' => apply_filters( 'woocommerce_api_product_attribute_terms_response', $attribute_terms, $terms, $fields, $this ) );
} catch ( WC_API_Exception $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
}