WC_API_Coupons::get_coupon_by_code( string $code, string $fields = null )
Get the coupon for the given code
Description Description
Parameters Parameters
- $code
-
(Required) the coupon code
- $fields
-
(Optional) fields to include in response
Default value: null
Return Return
(int|WP_Error)
Source Source
File: includes/legacy/api/v2/class-wc-api-coupons.php
public function get_coupon_by_code( $code, $fields = null ) {
global $wpdb;
try {
$id = $wpdb->get_var( $wpdb->prepare( "SELECT id FROM $wpdb->posts WHERE post_title = %s AND post_type = 'shop_coupon' AND post_status = 'publish' ORDER BY post_date DESC LIMIT 1;", $code ) );
if ( is_null( $id ) ) {
throw new WC_API_Exception( 'woocommerce_api_invalid_coupon_code', __( 'Invalid coupon code', 'woocommerce' ), 404 );
}
return $this->get_coupon( $id, $fields );
} catch ( WC_API_Exception $e ) {
return new WP_Error( $e->getErrorCode(), $e->getMessage(), array( 'status' => $e->getCode() ) );
}
}
Changelog Changelog
| Version | Description |
|---|---|
| 2.1 | Introduced. |