WC_API_Products::delete_product_shipping_class( int $id )
Delete a product shipping class.
Description Description
Parameters Parameters
- $id
-
(Required) Product shipping class term ID
Return Return
(array|WP_Error) Success message if succeed, otherwise WP_Error will be returned
Source Source
File: includes/legacy/api/v3/class-wc-api-products.php
public function delete_product_shipping_class( $id ) {
global $wpdb;
try {
// Check permissions
if ( ! current_user_can( 'manage_product_terms' ) ) {
throw new WC_API_Exception( 'woocommerce_api_user_cannot_delete_product_shipping_class', __( 'You do not have permission to delete product shipping classes', 'woocommerce' ), 401 );
}
$id = absint( $id );
$deleted = wp_delete_term( $id, 'product_shipping_class' );
if ( ! $deleted || is_wp_error( $deleted ) ) {
throw new WC_API_Exception( 'woocommerce_api_cannot_delete_product_shipping_class', __( 'Could not delete the shipping class', 'woocommerce' ), 401 );
}
do_action( 'woocommerce_api_delete_product_shipping_class', $id, $this );
return array( 'message' => sprintf( __( 'Deleted %s', 'woocommerce' ), 'product_shipping_class' ) );
} 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. |