Automattic\WooCommerce\StoreApi\Routes\V1
ProductsById{}
ProductsById class.
No Hooks.
Usage
$ProductsById = new ProductsById(); // use class methods
Methods
- public get_args()
- public get_path()
- public static get_path_regex()
- protected get_route_response( \WP_REST_Request $request )
ProductsById{} ProductsById{} code WC 9.3.1
class ProductsById extends AbstractRoute { /** * The route identifier. * * @var string */ const IDENTIFIER = 'products-by-id'; /** * The routes schema. * * @var string */ const SCHEMA_TYPE = 'product'; /** * Get the path of this REST route. * * @return string */ public function get_path() { return self::get_path_regex(); } /** * Get the path of this rest route. * * @return string */ public static function get_path_regex() { return '/products/(?P<id>[\d]+)'; } /** * Get method arguments for this REST route. * * @return array An array of endpoints. */ public function get_args() { return [ 'args' => array( 'id' => array( 'description' => __( 'Unique identifier for the resource.', 'woocommerce' ), 'type' => 'integer', ), ), [ 'methods' => \WP_REST_Server::READABLE, 'callback' => [ $this, 'get_response' ], 'permission_callback' => '__return_true', 'args' => array( 'context' => $this->get_context_param( array( 'default' => 'view', ) ), ), ], 'schema' => [ $this->schema, 'get_public_item_schema' ], ]; } /** * Get a single item. * * @throws RouteException On error. * @param \WP_REST_Request $request Request object. * @return \WP_REST_Response */ protected function get_route_response( \WP_REST_Request $request ) { $object = wc_get_product( (int) $request['id'] ); if ( ! $object || 0 === $object->get_id() ) { throw new RouteException( 'woocommerce_rest_product_invalid_id', __( 'Invalid product ID.', 'woocommerce' ), 404 ); } return rest_ensure_response( $this->schema->get_item_response( $object ) ); } }