WC_API_Products::get_product_shipping_class( string $id, string|null $fields = null )
Get the product shipping class for the given ID.
Description Description
Parameters Parameters
- $id
-
(Required) Product shipping class term ID
- $fields
-
(Optional) Fields to limit response to
Default value: null
Return Return
(array|WP_Error) Product shipping class if succeed, otherwise WP_Error will be returned
Source Source
File: includes/legacy/api/v3/class-wc-api-products.php
public function get_product_shipping_class( $id, $fields = null ) {
try {
$id = absint( $id );
if ( ! $id ) {
throw new WC_API_Exception( 'woocommerce_api_invalid_product_shipping_class_id', __( 'Invalid product shipping class ID', 'woocommerce' ), 400 );
}
// Permissions check
if ( ! current_user_can( 'manage_product_terms' ) ) {
throw new WC_API_Exception( 'woocommerce_api_user_cannot_read_product_shipping_classes', __( 'You do not have permission to read product shipping classes', 'woocommerce' ), 401 );
}
$term = get_term( $id, 'product_shipping_class' );
if ( is_wp_error( $term ) || is_null( $term ) ) {
throw new WC_API_Exception( 'woocommerce_api_invalid_product_shipping_class_id', __( 'A product shipping class with the provided ID could not be found', 'woocommerce' ), 404 );
}
$term_id = intval( $term->term_id );
$product_shipping_class = array(
'id' => $term_id,
'name' => $term->name,
'slug' => $term->slug,
'parent' => $term->parent,
'description' => $term->description,
'count' => intval( $term->count ),
);
return array( 'product_shipping_class' => apply_filters( 'woocommerce_api_product_shipping_class_response', $product_shipping_class, $id, $fields, $term, $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. |