class-wc-api.php — WooCommerce 8.0.0-rc.2

woocommerce / includes / class-wc-api.php

woocommerce / includes Last commit date

class-wc-api.php

186 lines

1	<?php
2	/**
3	* WC-API endpoint handler.
4	*
5	* This handles API related functionality in WooCommerce.
6	* - wc-api endpoint - Commonly used by Payment gateways for callbacks.
7	* - Legacy REST API - Deprecated in 2.6.0. @see class-wc-legacy-api.php
8	* - WP REST API - The main REST API in WooCommerce which is built on top of the WP REST API.
9	*
10	* @package WooCommerce\RestApi
11	* @since 2.0.0
12	*/
13
14	defined( 'ABSPATH' ) \|\| exit;
15
16	/**
17	* WC_API class.
18	*/
19	class WC_API extends WC_Legacy_API {
20
21	/**
22	* Init the API by setting up action and filter hooks.
23	*/
24	public function init() {
25	parent::init();
26	add_action( 'init', array( $this, 'add_endpoint' ), 0 );
27	add_filter( 'query_vars', array( $this, 'add_query_vars' ), 0 );
28	add_action( 'parse_request', array( $this, 'handle_api_requests' ), 0 );
29	add_action( 'rest_api_init', array( $this, 'register_wp_admin_settings' ) );
30	}
31
32	/**
33	* Get the version of the REST API package being ran. Since API package was merged into core, this now follows WC version.
34	*
35	* @since 3.7.0
36	* @return string\|null
37	*/
38	public function get_rest_api_package_version() {
39	if ( ! $this->is_rest_api_loaded() ) {
40	return null;
41	}
42	if ( method_exists( \Automattic\WooCommerce\RestApi\Server::class, 'get_path' ) ) {
43	$path = \Automattic\WooCommerce\RestApi\Server::get_path();
44	if ( 0 === strpos( $path, __DIR__ ) ) {
45	// We are loading API from included version.
46	return WC()->version;
47	}
48	}
49	// We are loading API from external plugin.
50	return \Automattic\WooCommerce\RestApi\Package::get_version();
51	}
52
53	/**
54	* Get the version of the REST API package being ran.
55	*
56	* @since 3.7.0
57	* @return string
58	*/
59	public function get_rest_api_package_path() {
60	if ( ! $this->is_rest_api_loaded() ) {
61	return null;
62	}
63	if ( method_exists( \Automattic\WooCommerce\RestApi\Server::class, 'get_path' ) ) {
64	// We are loading API from included version.
65	return \Automattic\WooCommerce\RestApi\Server::get_path();
66	}
67	// We are loading API from external plugin.
68	return \Automattic\WooCommerce\RestApi\Package::get_path();
69	}
70
71	/**
72	* Return if the rest API classes were already loaded.
73	*
74	* @since 3.7.0
75	* @return boolean
76	*/
77	protected function is_rest_api_loaded() {
78	return class_exists( '\Automattic\WooCommerce\RestApi\Server', false );
79	}
80
81	/**
82	* Get data from a WooCommerce API endpoint.
83	*
84	* @since 3.7.0
85	* @param string $endpoint Endpoint.
86	* @param array $params Params to pass with request.
87	* @return array\|\WP_Error
88	*/
89	public function get_endpoint_data( $endpoint, $params = array() ) {
90	if ( ! $this->is_rest_api_loaded() ) {
91	return new WP_Error( 'rest_api_unavailable', __( 'The Rest API is unavailable.', 'woocommerce' ) );
92	}
93	$request = new \WP_REST_Request( 'GET', $endpoint );
94	if ( $params ) {
95	$request->set_query_params( $params );
96	}
97	$response = rest_do_request( $request );
98	$server = rest_get_server();
99	$json = wp_json_encode( $server->response_to_data( $response, false ) );
100	return json_decode( $json, true );
101	}
102
103	/**
104	* Add new query vars.
105	*
106	* @since 2.0
107	* @param array $vars Query vars.
108	* @return string[]
109	*/
110	public function add_query_vars( $vars ) {
111	$vars = parent::add_query_vars( $vars );
112	$vars[] = 'wc-api';
113	return $vars;
114	}
115
116	/**
117	* WC API for payment gateway IPNs, etc.
118	*
119	* @since 2.0
120	*/
121	public static function add_endpoint() {
122	parent::add_endpoint();
123	add_rewrite_endpoint( 'wc-api', EP_ALL );
124	}
125
126	/**
127	* API request - Trigger any API requests.
128	*
129	* @since 2.0
130	* @version 2.4
131	*/
132	public function handle_api_requests() {
133	global $wp;
134
135	if ( ! empty( $_GET['wc-api'] ) ) { // WPCS: input var okay, CSRF ok.
136	$wp->query_vars['wc-api'] = sanitize_key( wp_unslash( $_GET['wc-api'] ) ); // WPCS: input var okay, CSRF ok.
137	}
138
139	// wc-api endpoint requests.
140	if ( ! empty( $wp->query_vars['wc-api'] ) ) {
141
142	// Buffer, we won't want any output here.
143	ob_start();
144
145	// No cache headers.
146	wc_nocache_headers();
147
148	// Clean the API request.
149	$api_request = strtolower( wc_clean( $wp->query_vars['wc-api'] ) );
150
151	// Make sure gateways are available for request.
152	WC()->payment_gateways();
153
154	// Trigger generic action before request hook.
155	do_action( 'woocommerce_api_request', $api_request );
156
157	// Is there actually something hooked into this API request? If not trigger 400 - Bad request.
158	status_header( has_action( 'woocommerce_api_' . $api_request ) ? 200 : 400 );
159
160	// Trigger an action which plugins can hook into to fulfill the request.
161	do_action( 'woocommerce_api_' . $api_request );
162
163	// Done, clear buffer and exit.
164	ob_end_clean();
165	die( '-1' );
166	}
167	}
168
169	/**
170	* Register WC settings from WP-API to the REST API.
171	*
172	* @since 3.0.0
173	*/
174	public function register_wp_admin_settings() {
175	$pages = WC_Admin_Settings::get_settings_pages();
176	foreach ( $pages as $page ) {
177	new WC_Register_WP_Admin_Settings( $page, 'page' );
178	}
179
180	$emails = WC_Emails::instance();
181	foreach ( $emails->get_emails() as $email ) {
182	new WC_Register_WP_Admin_Settings( $email, 'email' );
183	}
184	}
185	}
186