WC_API

WC_API class.

Contents

Description Description

Source Source

File: includes/class-wc-api.php

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

Expand full source code Collapse full source code

Top ↑

Top ↑

Methods Methods

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.