WC_API_Resource::validate_request( string|int $id, string $type, string $context )
Validate the request by checking:
Description Description
1) the ID is a valid integer 2) the ID returns a valid post object and matches the provided post type 3) the current user has the proper permissions to read/edit/delete the post
Parameters Parameters
- $id
-
(Required) the post ID
- $type
-
(Required) the post type, either
shop_order
,shop_coupon
, orproduct
- $context
-
(Required) the context of the request, either
read
,edit
ordelete
Return Return
(int|WP_Error) valid post ID or WP_Error if any of the checks fails
Source Source
File: includes/legacy/api/v2/class-wc-api-resource.php
protected function validate_request( $id, $type, $context ) { if ( 'shop_order' === $type || 'shop_coupon' === $type || 'shop_webhook' === $type ) { $resource_name = str_replace( 'shop_', '', $type ); } else { $resource_name = $type; } $id = absint( $id ); // Validate ID if ( empty( $id ) ) { return new WP_Error( "woocommerce_api_invalid_{$resource_name}_id", sprintf( __( 'Invalid %s ID', 'woocommerce' ), $type ), array( 'status' => 404 ) ); } // Only custom post types have per-post type/permission checks if ( 'customer' !== $type ) { $post = get_post( $id ); if ( null === $post ) { return new WP_Error( "woocommerce_api_no_{$resource_name}_found", sprintf( __( 'No %1$s found with the ID equal to %2$s', 'woocommerce' ), $resource_name, $id ), array( 'status' => 404 ) ); } // For checking permissions, product variations are the same as the product post type $post_type = ( 'product_variation' === $post->post_type ) ? 'product' : $post->post_type; // Validate post type if ( $type !== $post_type ) { return new WP_Error( "woocommerce_api_invalid_{$resource_name}", sprintf( __( 'Invalid %s', 'woocommerce' ), $resource_name ), array( 'status' => 404 ) ); } // Validate permissions switch ( $context ) { case 'read': if ( ! $this->is_readable( $post ) ) { return new WP_Error( "woocommerce_api_user_cannot_read_{$resource_name}", sprintf( __( 'You do not have permission to read this %s', 'woocommerce' ), $resource_name ), array( 'status' => 401 ) ); } break; case 'edit': if ( ! $this->is_editable( $post ) ) { return new WP_Error( "woocommerce_api_user_cannot_edit_{$resource_name}", sprintf( __( 'You do not have permission to edit this %s', 'woocommerce' ), $resource_name ), array( 'status' => 401 ) ); } break; case 'delete': if ( ! $this->is_deletable( $post ) ) { return new WP_Error( "woocommerce_api_user_cannot_delete_{$resource_name}", sprintf( __( 'You do not have permission to delete this %s', 'woocommerce' ), $resource_name ), array( 'status' => 401 ) ); } break; } } return $id; }
Changelog Changelog
Version | Description |
---|---|
2.1 | Introduced. |