AI
1 year ago
RateLimits
2 months ago
Reports
2 weeks ago
Templates
3 years ago
views
2 months ago
ActivityPanelCounts.php
2 weeks ago
AnalyticsImports.php
1 month ago
Coupons.php
4 years ago
CustomAttributeTraits.php
4 years ago
Customers.php
4 years ago
Data.php
4 years ago
DataCountries.php
4 years ago
DataDownloadIPs.php
4 years ago
Experiments.php
4 years ago
Features.php
4 years ago
Init.php
2 weeks ago
LaunchYourStore.php
1 year ago
Leaderboards.php
1 month ago
Marketing.php
3 months ago
MarketingCampaignTypes.php
3 years ago
MarketingCampaigns.php
1 month ago
MarketingChannels.php
3 years ago
MarketingOverview.php
3 months ago
MarketingRecommendations.php
2 years ago
MobileAppMagicLink.php
3 years ago
MobileAppQRLogin.php
2 months ago
NoteActions.php
2 months ago
Notes.php
2 months ago
Notice.php
1 year ago
OnboardingFreeExtensions.php
2 years ago
OnboardingPlugins.php
2 months ago
OnboardingProductTypes.php
4 years ago
OnboardingProducts.php
2 weeks ago
OnboardingProfile.php
1 year ago
OnboardingTasks.php
2 weeks ago
OnboardingThemes.php
3 weeks ago
Options.php
1 month ago
Orders.php
2 years ago
PaymentGatewaySuggestions.php
3 months ago
Plugins.php
3 months ago
ProductAttributeTerms.php
4 years ago
ProductAttributes.php
4 years ago
ProductCategories.php
4 years ago
ProductForm.php
3 years ago
ProductReviews.php
4 years ago
ProductVariations.php
1 year ago
Products.php
1 year ago
ProductsLowInStock.php
6 months ago
SettingOptions.php
3 years ago
Settings.php
2 months ago
ShippingPartnerSuggestions.php
3 months ago
Taxes.php
4 years ago
Themes.php
2 years ago
Init.php
276 lines
| 1 | <?php |
| 2 | /** |
| 3 | * REST API bootstrap. |
| 4 | */ |
| 5 | |
| 6 | namespace Automattic\WooCommerce\Admin\API; |
| 7 | |
| 8 | use AllowDynamicProperties; |
| 9 | use Automattic\WooCommerce\Admin\Features\Features; |
| 10 | use Automattic\WooCommerce\Utilities\FeaturesUtil; |
| 11 | |
| 12 | defined( 'ABSPATH' ) || exit; |
| 13 | |
| 14 | use Automattic\WooCommerce\Utilities\RestApiUtil; |
| 15 | |
| 16 | /** |
| 17 | * Init class. |
| 18 | * |
| 19 | * @internal |
| 20 | */ |
| 21 | #[AllowDynamicProperties] |
| 22 | class Init { |
| 23 | /** |
| 24 | * The single instance of the class. |
| 25 | * |
| 26 | * @var object |
| 27 | */ |
| 28 | protected static $instance = null; |
| 29 | |
| 30 | /** |
| 31 | * Get class instance. |
| 32 | * |
| 33 | * @return object Instance. |
| 34 | */ |
| 35 | final public static function instance() { |
| 36 | if ( null === static::$instance ) { |
| 37 | static::$instance = new static(); |
| 38 | } |
| 39 | return static::$instance; |
| 40 | } |
| 41 | |
| 42 | /** |
| 43 | * Bootstrap REST API. |
| 44 | */ |
| 45 | public function __construct() { |
| 46 | // Hook in data stores. |
| 47 | add_filter( 'woocommerce_data_stores', array( __CLASS__, 'add_data_stores' ) ); |
| 48 | // REST API extensions init. |
| 49 | add_action( 'rest_api_init', array( $this, 'rest_api_init' ) ); |
| 50 | |
| 51 | // Add currency symbol to orders endpoint response. |
| 52 | add_filter( 'woocommerce_rest_prepare_shop_order_object', array( __CLASS__, 'add_currency_symbol_to_order_response' ) ); |
| 53 | |
| 54 | include_once WC_ABSPATH . 'includes/admin/class-wc-admin-upload-downloadable-product.php'; |
| 55 | } |
| 56 | |
| 57 | /** |
| 58 | * Initialize the API namespaces under WooCommerce Admin. |
| 59 | * |
| 60 | * @return void |
| 61 | */ |
| 62 | public function rest_api_init() { |
| 63 | if ( wc_rest_should_load_namespace( 'wc-admin' ) ) { |
| 64 | $this->rest_api_init_wc_admin(); |
| 65 | } |
| 66 | |
| 67 | $rest_api_util = wc_get_container()->get( RestApiUtil::class ); |
| 68 | $rest_api_util->lazy_load_namespace( 'wc-analytics', array( $this, 'rest_api_init_wc_analytics' ) ); |
| 69 | |
| 70 | $controller = 'Automattic\WooCommerce\Admin\API\LaunchYourStore'; |
| 71 | $this->$controller = new $controller(); |
| 72 | $this->$controller->register_routes(); |
| 73 | } |
| 74 | |
| 75 | /** |
| 76 | * Load the wc-admin namespace controllers. |
| 77 | * |
| 78 | * @return void |
| 79 | */ |
| 80 | public function rest_api_init_wc_admin() { |
| 81 | $controllers = array( |
| 82 | 'Automattic\WooCommerce\Admin\API\Notice', |
| 83 | 'Automattic\WooCommerce\Admin\API\Features', |
| 84 | 'Automattic\WooCommerce\Admin\API\Experiments', |
| 85 | 'Automattic\WooCommerce\Admin\API\Marketing', |
| 86 | 'Automattic\WooCommerce\Admin\API\MarketingOverview', |
| 87 | 'Automattic\WooCommerce\Admin\API\MarketingRecommendations', |
| 88 | 'Automattic\WooCommerce\Admin\API\MarketingChannels', |
| 89 | 'Automattic\WooCommerce\Admin\API\MarketingCampaigns', |
| 90 | 'Automattic\WooCommerce\Admin\API\MarketingCampaignTypes', |
| 91 | 'Automattic\WooCommerce\Admin\API\Options', |
| 92 | 'Automattic\WooCommerce\Admin\API\PaymentGatewaySuggestions', |
| 93 | 'Automattic\WooCommerce\Admin\API\Themes', |
| 94 | 'Automattic\WooCommerce\Admin\API\Plugins', |
| 95 | 'Automattic\WooCommerce\Admin\API\OnboardingFreeExtensions', |
| 96 | 'Automattic\WooCommerce\Admin\API\OnboardingProductTypes', |
| 97 | 'Automattic\WooCommerce\Admin\API\OnboardingProfile', |
| 98 | 'Automattic\WooCommerce\Admin\API\OnboardingTasks', |
| 99 | 'Automattic\WooCommerce\Admin\API\OnboardingThemes', |
| 100 | 'Automattic\WooCommerce\Admin\API\OnboardingPlugins', |
| 101 | 'Automattic\WooCommerce\Admin\API\OnboardingProducts', |
| 102 | 'Automattic\WooCommerce\Admin\API\MobileAppMagicLink', |
| 103 | 'Automattic\WooCommerce\Admin\API\MobileAppQRLogin', |
| 104 | 'Automattic\WooCommerce\Admin\API\ShippingPartnerSuggestions', |
| 105 | ); |
| 106 | |
| 107 | if ( ! did_action( 'woocommerce_admin_rest_controllers' ) ) { |
| 108 | /** |
| 109 | * Filter for the WooCommerce Admin REST controllers. |
| 110 | * |
| 111 | * Admin and Analytics controllers were originally loaded in one place. However, with attempts to dynamically |
| 112 | * load namespaces based on context, these were split up. However, to maintain backward compatibility, we |
| 113 | * must run this hook if either namespace is loaded because extensions could be targeting either namespace. |
| 114 | * |
| 115 | * @param array $controllers List of rest API controllers. |
| 116 | * |
| 117 | * @since 3.5.0 |
| 118 | */ |
| 119 | $controllers = apply_filters( 'woocommerce_admin_rest_controllers', $controllers ); |
| 120 | if ( ! is_array( $controllers ) ) { |
| 121 | return; |
| 122 | } |
| 123 | } |
| 124 | |
| 125 | $controllers = array_values( array_unique( $controllers ) ); |
| 126 | foreach ( $controllers as $controller ) { |
| 127 | if ( is_string( $controller ) ) { |
| 128 | $this->$controller = new $controller(); |
| 129 | $this->$controller->register_routes(); |
| 130 | } |
| 131 | } |
| 132 | } |
| 133 | |
| 134 | /** |
| 135 | * Load the wc-analytics namespace controllers. |
| 136 | * |
| 137 | * @return void |
| 138 | */ |
| 139 | public function rest_api_init_wc_analytics() { |
| 140 | // Controllers in wc-analytics namespace, but loaded irrespective of analytics feature value. |
| 141 | $controllers = array( |
| 142 | 'Automattic\WooCommerce\Admin\API\Notes', |
| 143 | 'Automattic\WooCommerce\Admin\API\NoteActions', |
| 144 | 'Automattic\WooCommerce\Admin\API\Coupons', |
| 145 | 'Automattic\WooCommerce\Admin\API\Data', |
| 146 | 'Automattic\WooCommerce\Admin\API\DataCountries', |
| 147 | 'Automattic\WooCommerce\Admin\API\DataDownloadIPs', |
| 148 | 'Automattic\WooCommerce\Admin\API\Orders', |
| 149 | 'Automattic\WooCommerce\Admin\API\Products', |
| 150 | 'Automattic\WooCommerce\Admin\API\ProductAttributes', |
| 151 | 'Automattic\WooCommerce\Admin\API\ProductAttributeTerms', |
| 152 | 'Automattic\WooCommerce\Admin\API\ProductCategories', |
| 153 | 'Automattic\WooCommerce\Admin\API\ProductVariations', |
| 154 | 'Automattic\WooCommerce\Admin\API\ProductReviews', |
| 155 | 'Automattic\WooCommerce\Admin\API\ProductsLowInStock', |
| 156 | 'Automattic\WooCommerce\Admin\API\ActivityPanelCounts', |
| 157 | 'Automattic\WooCommerce\Admin\API\SettingOptions', |
| 158 | 'Automattic\WooCommerce\Admin\API\Taxes', |
| 159 | ); |
| 160 | |
| 161 | $analytics_controllers = array(); |
| 162 | if ( FeaturesUtil::feature_is_enabled( 'analytics' ) ) { |
| 163 | $analytics_controllers = array( |
| 164 | 'Automattic\WooCommerce\Admin\API\Customers', |
| 165 | 'Automattic\WooCommerce\Admin\API\Leaderboards', |
| 166 | 'Automattic\WooCommerce\Admin\API\Reports\Controller', |
| 167 | 'Automattic\WooCommerce\Admin\API\Reports\Import\Controller', |
| 168 | 'Automattic\WooCommerce\Admin\API\Reports\Export\Controller', |
| 169 | 'Automattic\WooCommerce\Admin\API\Reports\Products\Controller', |
| 170 | 'Automattic\WooCommerce\Admin\API\Reports\Variations\Controller', |
| 171 | 'Automattic\WooCommerce\Admin\API\Reports\Products\Stats\Controller', |
| 172 | 'Automattic\WooCommerce\Admin\API\Reports\Variations\Stats\Controller', |
| 173 | 'Automattic\WooCommerce\Admin\API\Reports\Revenue\Stats\Controller', |
| 174 | 'Automattic\WooCommerce\Admin\API\Reports\Orders\Controller', |
| 175 | 'Automattic\WooCommerce\Admin\API\Reports\Orders\Stats\Controller', |
| 176 | 'Automattic\WooCommerce\Admin\API\Reports\Categories\Controller', |
| 177 | 'Automattic\WooCommerce\Admin\API\Reports\Taxes\Controller', |
| 178 | 'Automattic\WooCommerce\Admin\API\Reports\Taxes\Stats\Controller', |
| 179 | 'Automattic\WooCommerce\Admin\API\Reports\Coupons\Controller', |
| 180 | 'Automattic\WooCommerce\Admin\API\Reports\Coupons\Stats\Controller', |
| 181 | 'Automattic\WooCommerce\Admin\API\Reports\Stock\Controller', |
| 182 | 'Automattic\WooCommerce\Admin\API\Reports\Stock\Stats\Controller', |
| 183 | 'Automattic\WooCommerce\Admin\API\Reports\Downloads\Controller', |
| 184 | 'Automattic\WooCommerce\Admin\API\Reports\Downloads\Stats\Controller', |
| 185 | 'Automattic\WooCommerce\Admin\API\Reports\Customers\Controller', |
| 186 | 'Automattic\WooCommerce\Admin\API\Reports\Customers\Stats\Controller', |
| 187 | ); |
| 188 | |
| 189 | // Registered whenever analytics is enabled (not gated on the |
| 190 | // scheduled-import feature): the status endpoint reports failed |
| 191 | // order imports in both immediate and scheduled modes. |
| 192 | $analytics_controllers[] = 'Automattic\WooCommerce\Admin\API\AnalyticsImports'; |
| 193 | |
| 194 | // The performance indicators controller must be registered last, after other /stats endpoints have been registered. |
| 195 | $analytics_controllers[] = 'Automattic\WooCommerce\Admin\API\Reports\PerformanceIndicators\Controller'; |
| 196 | } |
| 197 | |
| 198 | $controllers = array_merge( $analytics_controllers, $controllers ); |
| 199 | |
| 200 | if ( ! did_action( 'woocommerce_admin_rest_controllers' ) ) { |
| 201 | /** |
| 202 | * Filter for the WooCommerce Admin REST controllers. |
| 203 | * |
| 204 | * @param array $controllers List of rest API controllers. |
| 205 | * |
| 206 | * @since 3.5.0 |
| 207 | * |
| 208 | * @see self::rest_api_init_wc_admin() for extended documentation. |
| 209 | */ |
| 210 | $controllers = apply_filters( 'woocommerce_admin_rest_controllers', $controllers ); |
| 211 | if ( ! is_array( $controllers ) ) { |
| 212 | return; |
| 213 | } |
| 214 | } |
| 215 | |
| 216 | $controllers = array_values( array_unique( $controllers ) ); |
| 217 | foreach ( $controllers as $controller ) { |
| 218 | if ( is_string( $controller ) ) { |
| 219 | $this->$controller = new $controller(); |
| 220 | $this->$controller->register_routes(); |
| 221 | } |
| 222 | } |
| 223 | } |
| 224 | |
| 225 | /** |
| 226 | * Adds data stores. |
| 227 | * |
| 228 | * @internal |
| 229 | * @param array $data_stores List of data stores. |
| 230 | * @return array |
| 231 | */ |
| 232 | public static function add_data_stores( $data_stores ) { |
| 233 | return array_merge( |
| 234 | $data_stores, |
| 235 | array( |
| 236 | 'report-revenue-stats' => 'Automattic\WooCommerce\Admin\API\Reports\Orders\Stats\DataStore', |
| 237 | 'report-orders' => 'Automattic\WooCommerce\Admin\API\Reports\Orders\DataStore', |
| 238 | 'report-orders-stats' => 'Automattic\WooCommerce\Admin\API\Reports\Orders\Stats\DataStore', |
| 239 | 'report-products' => 'Automattic\WooCommerce\Admin\API\Reports\Products\DataStore', |
| 240 | 'report-variations' => 'Automattic\WooCommerce\Admin\API\Reports\Variations\DataStore', |
| 241 | 'report-products-stats' => 'Automattic\WooCommerce\Admin\API\Reports\Products\Stats\DataStore', |
| 242 | 'report-variations-stats' => 'Automattic\WooCommerce\Admin\API\Reports\Variations\Stats\DataStore', |
| 243 | 'report-categories' => 'Automattic\WooCommerce\Admin\API\Reports\Categories\DataStore', |
| 244 | 'report-taxes' => 'Automattic\WooCommerce\Admin\API\Reports\Taxes\DataStore', |
| 245 | 'report-taxes-stats' => 'Automattic\WooCommerce\Admin\API\Reports\Taxes\Stats\DataStore', |
| 246 | 'report-coupons' => 'Automattic\WooCommerce\Admin\API\Reports\Coupons\DataStore', |
| 247 | 'report-coupons-stats' => 'Automattic\WooCommerce\Admin\API\Reports\Coupons\Stats\DataStore', |
| 248 | 'report-downloads' => 'Automattic\WooCommerce\Admin\API\Reports\Downloads\DataStore', |
| 249 | 'report-downloads-stats' => 'Automattic\WooCommerce\Admin\API\Reports\Downloads\Stats\DataStore', |
| 250 | 'admin-note' => 'Automattic\WooCommerce\Admin\Notes\DataStore', |
| 251 | 'report-customers' => 'Automattic\WooCommerce\Admin\API\Reports\Customers\DataStore', |
| 252 | 'report-customers-stats' => 'Automattic\WooCommerce\Admin\API\Reports\Customers\Stats\DataStore', |
| 253 | 'report-stock-stats' => 'Automattic\WooCommerce\Admin\API\Reports\Stock\Stats\DataStore', |
| 254 | ) |
| 255 | ); |
| 256 | } |
| 257 | |
| 258 | /** |
| 259 | * Add the currency symbol (in addition to currency code) to each Order |
| 260 | * object in REST API responses. For use in formatAmount(). |
| 261 | * |
| 262 | * @internal |
| 263 | * @param WP_REST_Response $response REST response object. |
| 264 | * @returns WP_REST_Response |
| 265 | */ |
| 266 | public static function add_currency_symbol_to_order_response( $response ) { |
| 267 | $response_data = $response->get_data(); |
| 268 | $currency_code = $response_data['currency']; |
| 269 | $currency_symbol = get_woocommerce_currency_symbol( $currency_code ); |
| 270 | $response_data['currency_symbol'] = html_entity_decode( $currency_symbol ); |
| 271 | $response->set_data( $response_data ); |
| 272 | |
| 273 | return $response; |
| 274 | } |
| 275 | } |
| 276 |