<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WooCommerce Settings.

[2] Fix | Delete

*/

[3] Fix | Delete

[4] Fix | Delete

namespace Automattic\WooCommerce\Internal\Admin;

[5] Fix | Delete

[6] Fix | Delete

use Automattic\WooCommerce\Admin\API\Plugins;

[7] Fix | Delete

use Automattic\WooCommerce\Admin\API\Reports\Orders\DataStore as OrdersDataStore;

[8] Fix | Delete

use Automattic\WooCommerce\Admin\Features\Features;

[9] Fix | Delete

use Automattic\WooCommerce\Admin\PageController;

[10] Fix | Delete

use Automattic\WooCommerce\Admin\PluginsHelper;

[11] Fix | Delete

use Automattic\WooCommerce\Utilities\FeaturesUtil;

[12] Fix | Delete

use WC_Marketplace_Suggestions;

[13] Fix | Delete

[14] Fix | Delete

/**

[15] Fix | Delete

* Contains logic in regards to WooCommerce Admin Settings.

[16] Fix | Delete

*/

[17] Fix | Delete

class Settings {

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Class instance.

[21] Fix | Delete

*

[22] Fix | Delete

* @var Settings instance

[23] Fix | Delete

*/

[24] Fix | Delete

protected static $instance = null;

[25] Fix | Delete

[26] Fix | Delete

/**

[27] Fix | Delete

* Get class instance.

[28] Fix | Delete

*/

[29] Fix | Delete

public static function get_instance() {

[30] Fix | Delete

if ( ! self::$instance ) {

[31] Fix | Delete

self::$instance = new self();

[32] Fix | Delete

}

[33] Fix | Delete

return self::$instance;

[34] Fix | Delete

}

[35] Fix | Delete

[36] Fix | Delete

/**

[37] Fix | Delete

* Hook into WooCommerce.

[38] Fix | Delete

*/

[39] Fix | Delete

public function __construct() {

[40] Fix | Delete

// Old settings injection.

[41] Fix | Delete

add_filter( 'woocommerce_components_settings', array( $this, 'add_component_settings' ) );

[42] Fix | Delete

// New settings injection.

[43] Fix | Delete

add_filter( 'woocommerce_admin_shared_settings', array( $this, 'add_component_settings' ) );

[44] Fix | Delete

add_filter( 'woocommerce_settings_groups', array( $this, 'add_settings_group' ) );

[45] Fix | Delete

add_filter( 'woocommerce_settings-wc_admin', array( $this, 'add_settings' ) );

[46] Fix | Delete

}

[47] Fix | Delete

[48] Fix | Delete

/**

[49] Fix | Delete

* Format order statuses by removing a leading 'wc-' if present.

[50] Fix | Delete

*

[51] Fix | Delete

* @param array $statuses Order statuses.

[52] Fix | Delete

* @return array formatted statuses.

[53] Fix | Delete

*/

[54] Fix | Delete

public static function get_order_statuses( $statuses ) {

[55] Fix | Delete

$formatted_statuses = array();

[56] Fix | Delete

foreach ( $statuses as $key => $value ) {

[57] Fix | Delete

$formatted_key = preg_replace( '/^wc-/', '', $key );

[58] Fix | Delete

$formatted_statuses[ $formatted_key ] = $value;

[59] Fix | Delete

}

[60] Fix | Delete

return $formatted_statuses;

[61] Fix | Delete

}

[62] Fix | Delete

[63] Fix | Delete

/**

[64] Fix | Delete

* Get all order statuses present in analytics tables that aren't registered.

[65] Fix | Delete

*

[66] Fix | Delete

* @return array Unregistered order statuses.

[67] Fix | Delete

*/

[68] Fix | Delete

private function get_unregistered_order_statuses() {

[69] Fix | Delete

$registered_statuses = wc_get_order_statuses();

[70] Fix | Delete

$all_synced_statuses = OrdersDataStore::get_all_statuses();

[71] Fix | Delete

$unregistered_statuses = array_diff( $all_synced_statuses, array_keys( $registered_statuses ) );

[72] Fix | Delete

$formatted_status_keys = self::get_order_statuses( array_fill_keys( $unregistered_statuses, '' ) );

[73] Fix | Delete

$formatted_statuses = array_keys( $formatted_status_keys );

[74] Fix | Delete

[75] Fix | Delete

return array_combine( $formatted_statuses, $formatted_statuses );

[76] Fix | Delete

}

[77] Fix | Delete

[78] Fix | Delete

/**

[79] Fix | Delete

* Return an object defining the currency options for the site's current currency

[80] Fix | Delete

*

[81] Fix | Delete

* @return array Settings for the current currency {

[82] Fix | Delete

* Array of settings.

[83] Fix | Delete

*

[84] Fix | Delete

* @type string $code Currency code.

[85] Fix | Delete

* @type string $precision Number of decimals.

[86] Fix | Delete

* @type string $symbol Symbol for currency.

[87] Fix | Delete

* }

[88] Fix | Delete

*/

[89] Fix | Delete

public static function get_currency_settings() {

[90] Fix | Delete

$code = get_woocommerce_currency();

[91] Fix | Delete

[92] Fix | Delete

/**

[93] Fix | Delete

* The wc_currency_settings hook

[94] Fix | Delete

*

[95] Fix | Delete

* @since 6.5.0

[96] Fix | Delete

*/

[97] Fix | Delete

return apply_filters(

[98] Fix | Delete

'wc_currency_settings',

[99] Fix | Delete

array(

[100] Fix | Delete

'code' => $code,

[101] Fix | Delete

'precision' => wc_get_price_decimals(),

[102] Fix | Delete

'symbol' => html_entity_decode( get_woocommerce_currency_symbol( $code ) ),

[103] Fix | Delete

'symbolPosition' => get_option( 'woocommerce_currency_pos' ),

[104] Fix | Delete

'decimalSeparator' => wc_get_price_decimal_separator(),

[105] Fix | Delete

'thousandSeparator' => wc_get_price_thousand_separator(),

[106] Fix | Delete

'priceFormat' => html_entity_decode( get_woocommerce_price_format() ),

[107] Fix | Delete

)

[108] Fix | Delete

);

[109] Fix | Delete

}

[110] Fix | Delete

[111] Fix | Delete

/**

[112] Fix | Delete

* Hooks extra necessary data into the component settings array already set in WooCommerce core.

[113] Fix | Delete

*

[114] Fix | Delete

* @param array $settings Array of component settings.

[115] Fix | Delete

* @return array Array of component settings.

[116] Fix | Delete

*/

[117] Fix | Delete

public function add_component_settings( $settings ) {

[118] Fix | Delete

if ( ! is_admin() ) {

[119] Fix | Delete

return $settings;

[120] Fix | Delete

}

[121] Fix | Delete

[122] Fix | Delete

if ( ! function_exists( 'wc_blocks_container' ) ) {

[123] Fix | Delete

global $wp_locale;

[124] Fix | Delete

// inject data not available via older versions of wc_blocks/woo.

[125] Fix | Delete

$settings['orderStatuses'] = self::get_order_statuses( wc_get_order_statuses() );

[126] Fix | Delete

$settings['stockStatuses'] = self::get_order_statuses( wc_get_product_stock_status_options() );

[127] Fix | Delete

$settings['currency'] = self::get_currency_settings();

[128] Fix | Delete

$settings['locale'] = array(

[129] Fix | Delete

'siteLocale' => isset( $settings['siteLocale'] )

[130] Fix | Delete

? $settings['siteLocale']

[131] Fix | Delete

: get_locale(),

[132] Fix | Delete

'userLocale' => isset( $settings['l10n']['userLocale'] )

[133] Fix | Delete

? $settings['l10n']['userLocale']

[134] Fix | Delete

: get_user_locale(),

[135] Fix | Delete

'weekdaysShort' => isset( $settings['l10n']['weekdaysShort'] )

[136] Fix | Delete

? $settings['l10n']['weekdaysShort']

[137] Fix | Delete

: array_values( $wp_locale->weekday_abbrev ),

[138] Fix | Delete

);

[139] Fix | Delete

}

[140] Fix | Delete

[141] Fix | Delete

//phpcs:ignore

[142] Fix | Delete

$preload_data_endpoints = apply_filters( 'woocommerce_component_settings_preload_endpoints', array() );

[143] Fix | Delete

$preload_data_endpoints['jetpackStatus'] = '/jetpack/v4/connection';

[144] Fix | Delete

if ( ! empty( $preload_data_endpoints ) ) {

[145] Fix | Delete

$preload_data = array_reduce(

[146] Fix | Delete

array_values( $preload_data_endpoints ),

[147] Fix | Delete

'rest_preload_api_request'

[148] Fix | Delete

);

[149] Fix | Delete

}

[150] Fix | Delete

[151] Fix | Delete

//phpcs:ignore

[152] Fix | Delete

$preload_options = apply_filters( 'woocommerce_admin_preload_options', array() );

[153] Fix | Delete

if ( ! empty( $preload_options ) ) {

[154] Fix | Delete

foreach ( $preload_options as $option ) {

[155] Fix | Delete

$settings['preloadOptions'][ $option ] = get_option( $option );

[156] Fix | Delete

}

[157] Fix | Delete

}

[158] Fix | Delete

[159] Fix | Delete

//phpcs:ignore

[160] Fix | Delete

$preload_settings = apply_filters( 'woocommerce_admin_preload_settings', array() );

[161] Fix | Delete

if ( ! empty( $preload_settings ) ) {

[162] Fix | Delete

$setting_options = new \WC_REST_Setting_Options_V2_Controller();

[163] Fix | Delete

foreach ( $preload_settings as $group ) {

[164] Fix | Delete

$group_settings = $setting_options->get_group_settings( $group );

[165] Fix | Delete

$preload_settings = array();

[166] Fix | Delete

foreach ( $group_settings as $option ) {

[167] Fix | Delete

if ( array_key_exists( 'id', $option ) && array_key_exists( 'value', $option ) ) {

[168] Fix | Delete

$preload_settings[ $option['id'] ] = $option['value'];

[169] Fix | Delete

}

[170] Fix | Delete

}

[171] Fix | Delete

$settings['preloadSettings'][ $group ] = $preload_settings;

[172] Fix | Delete

}

[173] Fix | Delete

}

[174] Fix | Delete

[175] Fix | Delete

$user_controller = new \WP_REST_Users_Controller();

[176] Fix | Delete

$request = new \WP_REST_Request();

[177] Fix | Delete

$request->set_query_params( array( 'context' => 'edit' ) );

[178] Fix | Delete

$user_response = $user_controller->get_current_item( $request );

[179] Fix | Delete

$current_user_data = is_wp_error( $user_response ) ? (object) array() : $user_response->get_data();

[180] Fix | Delete

[181] Fix | Delete

$settings['currentUserData'] = $current_user_data;

[182] Fix | Delete

$settings['reviewsEnabled'] = get_option( 'woocommerce_enable_reviews' );

[183] Fix | Delete

$settings['manageStock'] = get_option( 'woocommerce_manage_stock' );

[184] Fix | Delete

$settings['commentModeration'] = get_option( 'comment_moderation' );

[185] Fix | Delete

$settings['notifyLowStockAmount'] = get_option( 'woocommerce_notify_low_stock_amount' );

[186] Fix | Delete

[187] Fix | Delete

/**

[188] Fix | Delete

* Deprecate wcAdminAssetUrl as we no longer need it after The Merge.

[189] Fix | Delete

* Use wcAssetUrl instead.

[190] Fix | Delete

*

[191] Fix | Delete

* @deprecated 6.7.0

[192] Fix | Delete

* @var string

[193] Fix | Delete

*/

[194] Fix | Delete

$settings['wcAdminAssetUrl'] = WC_ADMIN_IMAGES_FOLDER_URL;

[195] Fix | Delete

$settings['wcVersion'] = WC_VERSION;

[196] Fix | Delete

$settings['siteUrl'] = site_url();

[197] Fix | Delete

$settings['shopUrl'] = get_permalink( wc_get_page_id( 'shop' ) );

[198] Fix | Delete

$settings['homeUrl'] = home_url();

[199] Fix | Delete

$settings['dateFormat'] = get_option( 'date_format' );

[200] Fix | Delete

$settings['timeZone'] = wc_timezone_string();

[201] Fix | Delete

$settings['plugins'] = array(

[202] Fix | Delete

'installedPlugins' => PluginsHelper::get_installed_plugin_slugs(),

[203] Fix | Delete

'activePlugins' => Plugins::get_active_plugins(),

[204] Fix | Delete

);

[205] Fix | Delete

[206] Fix | Delete

// DO NOT use outside of core, these can be removed without deprecation.

[207] Fix | Delete

$settings['__experimentalFlags'] = array();

[208] Fix | Delete

[209] Fix | Delete

// Plugins that depend on changing the translation work on the server but not the client -

[210] Fix | Delete

// WooCommerce Branding is an example of this - so pass through the translation of

[211] Fix | Delete

// 'WooCommerce' to wcSettings.

[212] Fix | Delete

$settings['woocommerceTranslation'] = __( 'WooCommerce', 'woocommerce' );

[213] Fix | Delete

[214] Fix | Delete

if ( PageController::is_admin_page() && Features::is_enabled( 'analytics' ) ) {

[215] Fix | Delete

// We may have synced orders with a now-unregistered status.

[216] Fix | Delete

// E.g. an extension that added statuses is now inactive or removed.

[217] Fix | Delete

$settings['unregisteredOrderStatuses'] = $this->get_unregistered_order_statuses();

[218] Fix | Delete

}

[219] Fix | Delete

[220] Fix | Delete

// The separator used for attributes found in Variation titles.

[221] Fix | Delete

//phpcs:ignore

[222] Fix | Delete

$settings['variationTitleAttributesSeparator'] = apply_filters( 'woocommerce_product_variation_title_attributes_separator', ' - ', new \WC_Product() );

[223] Fix | Delete

[224] Fix | Delete

if ( ! empty( $preload_data_endpoints ) ) {

[225] Fix | Delete

$settings['dataEndpoints'] = isset( $settings['dataEndpoints'] )

[226] Fix | Delete

? $settings['dataEndpoints']

[227] Fix | Delete

: array();

[228] Fix | Delete

foreach ( $preload_data_endpoints as $key => $endpoint ) {

[229] Fix | Delete

// Handle error case: rest_do_request() doesn't guarantee success.

[230] Fix | Delete

if ( empty( $preload_data[ $endpoint ] ) ) {

[231] Fix | Delete

$settings['dataEndpoints'][ $key ] = array();

[232] Fix | Delete

} else {

[233] Fix | Delete

$settings['dataEndpoints'][ $key ] = $preload_data[ $endpoint ]['body'];

[234] Fix | Delete

}

[235] Fix | Delete

}

[236] Fix | Delete

}

[237] Fix | Delete

$settings = $this->get_custom_settings( $settings );

[238] Fix | Delete

if ( PageController::is_embed_page() ) {

[239] Fix | Delete

$settings['embedBreadcrumbs'] = wc_admin_get_breadcrumbs();

[240] Fix | Delete

}

[241] Fix | Delete

[242] Fix | Delete

$settings['allowMarketplaceSuggestions'] = WC_Marketplace_Suggestions::allow_suggestions();

[243] Fix | Delete

$settings['connectNonce'] = wp_create_nonce( 'connect' );

[244] Fix | Delete

$settings['wcpay_welcome_page_connect_nonce'] = wp_create_nonce( 'wcpay-connect' );

[245] Fix | Delete

$settings['email_preview_nonce'] = wp_create_nonce( 'email-preview-nonce' );

[246] Fix | Delete

$settings['email_listing_nonce'] = wp_create_nonce( 'email-listing-nonce' );

[247] Fix | Delete

$settings['wc_helper_nonces'] = array(

[248] Fix | Delete

'refresh' => wp_create_nonce( 'refresh' ),

[249] Fix | Delete

);

[250] Fix | Delete

[251] Fix | Delete

$settings['features'] = $this->get_features();

[252] Fix | Delete

[253] Fix | Delete

$has_gutenberg = is_plugin_active( 'gutenberg/gutenberg.php' );

[254] Fix | Delete

$gutenberg_version = '';

[255] Fix | Delete

if ( $has_gutenberg ) {

[256] Fix | Delete

if ( defined( 'GUTENBERG_VERSION' ) ) {

[257] Fix | Delete

$gutenberg_version = GUTENBERG_VERSION;

[258] Fix | Delete

}

[259] Fix | Delete

[260] Fix | Delete

if ( ! $gutenberg_version ) {

[261] Fix | Delete

$gutenberg_data = get_plugin_data( WP_PLUGIN_DIR . '/gutenberg/gutenberg.php' );

[262] Fix | Delete

$gutenberg_version = $gutenberg_data['Version'];

[263] Fix | Delete

}

[264] Fix | Delete

}

[265] Fix | Delete

$settings['gutenberg_version'] = $has_gutenberg ? $gutenberg_version : 0;

[266] Fix | Delete

[267] Fix | Delete

return $settings;

[268] Fix | Delete

}

[269] Fix | Delete

[270] Fix | Delete

/**

[271] Fix | Delete

* Removes non-necessary feature properties for the client side.

[272] Fix | Delete

*

[273] Fix | Delete

* @return array

[274] Fix | Delete

*/

[275] Fix | Delete

public function get_features() {

[276] Fix | Delete

$features = FeaturesUtil::get_features( true, true );

[277] Fix | Delete

$new_features = array();

[278] Fix | Delete

[279] Fix | Delete

foreach ( array_keys( $features ) as $feature_id ) {

[280] Fix | Delete

$new_features[ $feature_id ] = array(

[281] Fix | Delete

'is_enabled' => $features[ $feature_id ]['is_enabled'],

[282] Fix | Delete

'is_experimental' => $features[ $feature_id ]['is_experimental'] ?? false,

[283] Fix | Delete

);

[284] Fix | Delete

}

[285] Fix | Delete

[286] Fix | Delete

return $new_features;

[287] Fix | Delete

}

[288] Fix | Delete

[289] Fix | Delete

/**

[290] Fix | Delete

* Register the admin settings for use in the WC REST API

[291] Fix | Delete

*

[292] Fix | Delete

* @param array $groups Array of setting groups.

[293] Fix | Delete

* @return array

[294] Fix | Delete

*/

[295] Fix | Delete

public function add_settings_group( $groups ) {

[296] Fix | Delete

$groups[] = array(

[297] Fix | Delete

'id' => 'wc_admin',

[298] Fix | Delete

'label' => __( 'WooCommerce Admin', 'woocommerce' ),

[299] Fix | Delete

'description' => __( 'Settings for WooCommerce admin reporting.', 'woocommerce' ),

[300] Fix | Delete

);

[301] Fix | Delete

return $groups;

[302] Fix | Delete

}

[303] Fix | Delete

[304] Fix | Delete

/**

[305] Fix | Delete

* Add WC Admin specific settings

[306] Fix | Delete

*

[307] Fix | Delete

* @param array $settings Array of settings in wc admin group.

[308] Fix | Delete

* @return array

[309] Fix | Delete

*/

[310] Fix | Delete

public function add_settings( $settings ) {

[311] Fix | Delete

$unregistered_statuses = $this->get_unregistered_order_statuses();

[312] Fix | Delete

$registered_statuses = self::get_order_statuses( wc_get_order_statuses() );

[313] Fix | Delete

$all_statuses = array_merge( $unregistered_statuses, $registered_statuses );

[314] Fix | Delete

[315] Fix | Delete

$settings[] = array(

[316] Fix | Delete

'id' => 'woocommerce_excluded_report_order_statuses',

[317] Fix | Delete

'option_key' => 'woocommerce_excluded_report_order_statuses',

[318] Fix | Delete

'label' => __( 'Excluded report order statuses', 'woocommerce' ),

[319] Fix | Delete

'description' => __( 'Statuses that should not be included when calculating report totals.', 'woocommerce' ),

[320] Fix | Delete

'default' => array( 'pending', 'cancelled', 'failed' ),

[321] Fix | Delete

'type' => 'multiselect',

[322] Fix | Delete

'options' => $all_statuses,

[323] Fix | Delete

);

[324] Fix | Delete

$settings[] = array(

[325] Fix | Delete

'id' => 'woocommerce_actionable_order_statuses',

[326] Fix | Delete

'option_key' => 'woocommerce_actionable_order_statuses',

[327] Fix | Delete

'label' => __( 'Actionable order statuses', 'woocommerce' ),

[328] Fix | Delete

'description' => __( 'Statuses that require extra action on behalf of the store admin.', 'woocommerce' ),

[329] Fix | Delete

'default' => array( 'processing', 'on-hold' ),

[330] Fix | Delete

'type' => 'multiselect',

[331] Fix | Delete

'options' => $all_statuses,

[332] Fix | Delete

);

[333] Fix | Delete

$settings[] = array(

[334] Fix | Delete

'id' => 'woocommerce_default_date_range',

[335] Fix | Delete

'option_key' => 'woocommerce_default_date_range',

[336] Fix | Delete

'label' => __( 'Default Date Range', 'woocommerce' ),

[337] Fix | Delete

'description' => __( 'Default Date Range', 'woocommerce' ),

[338] Fix | Delete

'default' => 'period=month&compare=previous_year',

[339] Fix | Delete

'type' => 'text',

[340] Fix | Delete

);

[341] Fix | Delete

$settings[] = array(

[342] Fix | Delete

'id' => 'woocommerce_date_type',

[343] Fix | Delete

'option_key' => 'woocommerce_date_type',

[344] Fix | Delete

'label' => __( 'Date Type', 'woocommerce' ),

[345] Fix | Delete

'description' => __( 'Database date field considered for Revenue and Orders reports', 'woocommerce' ),

[346] Fix | Delete

'type' => 'select',

[347] Fix | Delete

'options' => array(

[348] Fix | Delete

'date_created' => 'date_created',

[349] Fix | Delete

'date_paid' => 'date_paid',

[350] Fix | Delete

'date_completed' => 'date_completed',

[351] Fix | Delete

),

[352] Fix | Delete

);

[353] Fix | Delete

return $settings;

[354] Fix | Delete

}

[355] Fix | Delete

[356] Fix | Delete

/**

[357] Fix | Delete

* Gets custom settings used for WC Admin.

[358] Fix | Delete

*

[359] Fix | Delete

* @param array $settings Array of settings to merge into.

[360] Fix | Delete

* @return array

[361] Fix | Delete

*/

[362] Fix | Delete

private function get_custom_settings( $settings ) {

[363] Fix | Delete

$wc_rest_settings_options_controller = new \WC_REST_Setting_Options_Controller();

[364] Fix | Delete

$wc_admin_group_settings = $wc_rest_settings_options_controller->get_group_settings( 'wc_admin' );

[365] Fix | Delete

$settings['wcAdminSettings'] = array();

[366] Fix | Delete

[367] Fix | Delete

foreach ( $wc_admin_group_settings as $setting ) {

[368] Fix | Delete

if ( ! empty( $setting['id'] ) ) {

[369] Fix | Delete

$settings['wcAdminSettings'][ $setting['id'] ] = $setting['value'];

[370] Fix | Delete

}

[371] Fix | Delete

}

[372] Fix | Delete

return $settings;

[373] Fix | Delete

}

[374] Fix | Delete

}

[375] Fix | Delete

[376] Fix | Delete