WC_API_Coupons::get_coupons( string $fields = null, array $filter = array(), int $page = 1 )
Get all coupons
Description Description
Parameters Parameters
- $fields
-
(Optional)
Default value: null
- $filter
-
(Optional)
Default value: array()
- $page
-
(Optional)
Default value: 1
Return Return
(array)
Source Source
File: includes/legacy/api/v2/class-wc-api-coupons.php
public function get_coupons( $fields = null, $filter = array(), $page = 1 ) { $filter['page'] = $page; $query = $this->query_coupons( $filter ); $coupons = array(); foreach ( $query->posts as $coupon_id ) { if ( ! $this->is_readable( $coupon_id ) ) { continue; } $coupons[] = current( $this->get_coupon( $coupon_id, $fields ) ); } $this->server->add_pagination_headers( $query ); return array( 'coupons' => $coupons ); }
Changelog Changelog
Version | Description |
---|---|
2.1 | Introduced. |