<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WooCommerce Settings.

[2] Fix | Delete

*/

[3] Fix | Delete

[4] Fix | Delete

declare( strict_types = 1 );

[5] Fix | Delete

[6] Fix | Delete

namespace Automattic\WooCommerce\Admin\Features\Settings;

[7] Fix | Delete

[8] Fix | Delete

use Automattic\WooCommerce\Internal\Admin\WCAdminAssets;

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Contains backend logic for the Settings feature.

[12] Fix | Delete

*/

[13] Fix | Delete

class Init {

[14] Fix | Delete

/**

[15] Fix | Delete

* Class instance.

[16] Fix | Delete

*

[17] Fix | Delete

* @var Init instance

[18] Fix | Delete

*/

[19] Fix | Delete

protected static $instance = null;

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* Get class instance.

[23] Fix | Delete

*/

[24] Fix | Delete

public static function get_instance() {

[25] Fix | Delete

if ( ! self::$instance ) {

[26] Fix | Delete

self::$instance = new self();

[27] Fix | Delete

}

[28] Fix | Delete

return self::$instance;

[29] Fix | Delete

}

[30] Fix | Delete

[31] Fix | Delete

/**

[32] Fix | Delete

* Hook into WooCommerce.

[33] Fix | Delete

*/

[34] Fix | Delete

public function __construct() {

[35] Fix | Delete

if ( ! is_admin() ) {

[36] Fix | Delete

return;

[37] Fix | Delete

}

[38] Fix | Delete

[39] Fix | Delete

add_filter( 'woocommerce_admin_shared_settings', array( __CLASS__, 'add_component_settings' ) );

[40] Fix | Delete

add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_settings_editor_scripts' ) );

[41] Fix | Delete

add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_settings_editor_styles' ) );

[42] Fix | Delete

}

[43] Fix | Delete

[44] Fix | Delete

/**

[45] Fix | Delete

* Check if the current screen is the WooCommerce settings page.

[46] Fix | Delete

*

[47] Fix | Delete

* @return bool

[48] Fix | Delete

*/

[49] Fix | Delete

public function is_settings_page() {

[50] Fix | Delete

$screen = get_current_screen();

[51] Fix | Delete

return $screen && 'woocommerce_page_wc-settings' === $screen->id;

[52] Fix | Delete

}

[53] Fix | Delete

[54] Fix | Delete

/**

[55] Fix | Delete

* Enqueue styles for the settings editor.

[56] Fix | Delete

*/

[57] Fix | Delete

public function enqueue_settings_editor_styles() {

[58] Fix | Delete

if ( ! self::get_instance()->is_settings_page() ) {

[59] Fix | Delete

return;

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

$style_name = 'wc-admin-edit-settings';

[63] Fix | Delete

$style_path_name = 'settings';

[64] Fix | Delete

$style_assets_filename = WCAdminAssets::get_script_asset_filename( $style_path_name, 'style' );

[65] Fix | Delete

$style_assets = require WC_ADMIN_ABSPATH . WC_ADMIN_DIST_JS_FOLDER . $style_path_name . '/' . $style_assets_filename;

[66] Fix | Delete

[67] Fix | Delete

// Settings Editor styles.

[68] Fix | Delete

wp_register_style(

[69] Fix | Delete

$style_name,

[70] Fix | Delete

WCAdminAssets::get_url( $style_path_name . '/style', 'css' ),

[71] Fix | Delete

// Manually set dependencies for now, because the asset file is not being generated correctly.

[72] Fix | Delete

// See plugins/woocommerce/assets/client/admin/settings-editor/style.asset.php. Should be: `isset( $style_assets['dependencies'] ) ? $style_assets['dependencies'] : array(),`.

[73] Fix | Delete

array( 'wp-components', 'wc-components' ),

[74] Fix | Delete

WCAdminAssets::get_file_version( 'css', $style_assets['version'] ),

[75] Fix | Delete

);

[76] Fix | Delete

[77] Fix | Delete

wp_enqueue_style( $style_name );

[78] Fix | Delete

[79] Fix | Delete

// Global presets styles.

[80] Fix | Delete

wp_register_style( 'wc-global-presets', false ); // phpcs:ignore

[81] Fix | Delete

wp_add_inline_style( 'wc-global-presets', wp_get_global_stylesheet( array( 'presets' ) ) );

[82] Fix | Delete

wp_enqueue_style( 'wc-global-presets' );

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

/**

[86] Fix | Delete

* Enqueue scripts for the settings editor.

[87] Fix | Delete

*/

[88] Fix | Delete

public function enqueue_settings_editor_scripts() {

[89] Fix | Delete

if ( ! self::get_instance()->is_settings_page() ) {

[90] Fix | Delete

return;

[91] Fix | Delete

}

[92] Fix | Delete

[93] Fix | Delete

// Make sure the Settings Editor package is loaded.

[94] Fix | Delete

wp_enqueue_script( 'wc-settings-editor' );

[95] Fix | Delete

wp_enqueue_style( 'wc-settings-editor' );

[96] Fix | Delete

[97] Fix | Delete

$script_name = 'wc-admin-edit-settings';

[98] Fix | Delete

$script_path_name = 'settings';

[99] Fix | Delete

$script_assets_filename = WCAdminAssets::get_script_asset_filename( $script_path_name, 'index' );

[100] Fix | Delete

$script_assets = require WC_ADMIN_ABSPATH . WC_ADMIN_DIST_JS_FOLDER . $script_path_name . '/' . $script_assets_filename;

[101] Fix | Delete

[102] Fix | Delete

wp_enqueue_script(

[103] Fix | Delete

$script_name,

[104] Fix | Delete

WCAdminAssets::get_url( $script_path_name . '/index', 'js' ),

[105] Fix | Delete

$script_assets['dependencies'],

[106] Fix | Delete

WCAdminAssets::get_file_version( 'js', $script_assets['version'] ),

[107] Fix | Delete

true

[108] Fix | Delete

);

[109] Fix | Delete

[110] Fix | Delete

wp_set_script_translations( 'wc-admin-' . $script_name, 'woocommerce' );

[111] Fix | Delete

}

[112] Fix | Delete

[113] Fix | Delete

/**

[114] Fix | Delete

* Add the necessary data to initially load the WooCommerce Settings pages.

[115] Fix | Delete

*

[116] Fix | Delete

* @param array $settings Array of component settings.

[117] Fix | Delete

* @return array Array of component settings.

[118] Fix | Delete

*/

[119] Fix | Delete

public static function add_component_settings( $settings ) {

[120] Fix | Delete

if ( ! self::get_instance()->is_settings_page() ) {

[121] Fix | Delete

return $settings;

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

global $wp_scripts;

[125] Fix | Delete

[126] Fix | Delete

// Set the scripts that all settings pages should have.

[127] Fix | Delete

$ignored_settings_scripts = array(

[128] Fix | Delete

'wc-admin-app',

[129] Fix | Delete

'woocommerce_admin',

[130] Fix | Delete

'wc-settings-editor',

[131] Fix | Delete

'wc-admin-edit-settings',

[132] Fix | Delete

'woo-tracks',

[133] Fix | Delete

'woocommerce-admin-test-helper',

[134] Fix | Delete

'woocommerce-beta-tester-live-branches',

[135] Fix | Delete

'WCPAY_DASH_APP',

[136] Fix | Delete

);

[137] Fix | Delete

$default_scripts_handles = array_diff(

[138] Fix | Delete

$wp_scripts->queue,

[139] Fix | Delete

$ignored_settings_scripts,

[140] Fix | Delete

);

[141] Fix | Delete

$settings['settingsScripts']['_default'] = self::get_script_urls( $default_scripts_handles );

[142] Fix | Delete

[143] Fix | Delete

// Add the settings data to the settings array.

[144] Fix | Delete

$setting_pages = \WC_Admin_Settings::get_settings_pages();

[145] Fix | Delete

$settings = self::get_page_data( $settings, $setting_pages );

[146] Fix | Delete

[147] Fix | Delete

return $settings;

[148] Fix | Delete

}

[149] Fix | Delete

[150] Fix | Delete

/**

[151] Fix | Delete

* Get the page data for the settings editor.

[152] Fix | Delete

*

[153] Fix | Delete

* @param array $settings The settings array.

[154] Fix | Delete

* @param array $setting_pages The setting pages.

[155] Fix | Delete

* @return array The settings array.

[156] Fix | Delete

*/

[157] Fix | Delete

public static function get_page_data( $settings, $setting_pages ) {

[158] Fix | Delete

global $wp_scripts;

[159] Fix | Delete

/**

[160] Fix | Delete

* Filters the settings tabs array.

[161] Fix | Delete

*

[162] Fix | Delete

* @since 2.5.0

[163] Fix | Delete

*

[164] Fix | Delete

* @param array $available_pages The available pages.

[165] Fix | Delete

*/

[166] Fix | Delete

$available_pages = apply_filters( 'woocommerce_settings_tabs_array', array() );

[167] Fix | Delete

$pages = array();

[168] Fix | Delete

[169] Fix | Delete

foreach ( $setting_pages as $setting_page ) {

[170] Fix | Delete

// If any page has removed itself from the tabs array, avoid adding this page to the settings editor.

[171] Fix | Delete

if ( ! in_array( $setting_page->get_id(), array_keys( $available_pages ), true ) ) {

[172] Fix | Delete

continue;

[173] Fix | Delete

}

[174] Fix | Delete

[175] Fix | Delete

$scripts_before_adding_settings = $wp_scripts->queue;

[176] Fix | Delete

$pages = $setting_page->add_settings_page_data( $pages );

[177] Fix | Delete

$settings_scripts_handles = array_diff( $wp_scripts->queue, $scripts_before_adding_settings );

[178] Fix | Delete

$settings['settingsScripts'][ $setting_page->get_id() ] = self::get_script_urls( $settings_scripts_handles );

[179] Fix | Delete

}

[180] Fix | Delete

[181] Fix | Delete

$transformer = new Transformer();

[182] Fix | Delete

$settings['settingsData']['pages'] = $transformer->transform( $pages );

[183] Fix | Delete

$settings['settingsData']['start'] = $setting_pages[0]->get_custom_view( 'woocommerce_settings_start' );

[184] Fix | Delete

$settings['settingsData']['_wpnonce'] = wp_create_nonce( 'wp_rest' );

[185] Fix | Delete

[186] Fix | Delete

return $settings;

[187] Fix | Delete

}

[188] Fix | Delete

[189] Fix | Delete

/**

[190] Fix | Delete

* Retrieve the script URLs from the provided script handles.

[191] Fix | Delete

* This will also filter out scripts from WordPress core since they only need to be loaded once.

[192] Fix | Delete

*

[193] Fix | Delete

* @param array $script_handles Array of script handles.

[194] Fix | Delete

* @return array Array of script URLs.

[195] Fix | Delete

*/

[196] Fix | Delete

private static function get_script_urls( $script_handles ) {

[197] Fix | Delete

global $wp_scripts;

[198] Fix | Delete

$script_urls = array();

[199] Fix | Delete

foreach ( $script_handles as $script ) {

[200] Fix | Delete

$registered_script = $wp_scripts->registered[ $script ];

[201] Fix | Delete

if ( ! isset( $registered_script->src ) ) {

[202] Fix | Delete

continue;

[203] Fix | Delete

}

[204] Fix | Delete

[205] Fix | Delete

// Skip scripts from WordPress core since they only need to be loaded once.

[206] Fix | Delete

if ( strpos( $registered_script->src, '/' . WPINC . '/js' ) === 0 || strpos( $registered_script->src, '/wp-admin/js' ) === 0 ) {

[207] Fix | Delete

continue;

[208] Fix | Delete

}

[209] Fix | Delete

[210] Fix | Delete

$src = $registered_script->src;

[211] Fix | Delete

$ver = $registered_script->ver ? $registered_script->ver : false;

[212] Fix | Delete

[213] Fix | Delete

// Add version query parameter.

[214] Fix | Delete

if ( $ver ) {

[215] Fix | Delete

$src = add_query_arg( 'ver', $ver, $src );

[216] Fix | Delete

}

[217] Fix | Delete

[218] Fix | Delete

// Add home URL if the src is a relative path.

[219] Fix | Delete

if ( strpos( $src, '/' ) === 0 ) {

[220] Fix | Delete

$script_urls[] = home_url( $src );

[221] Fix | Delete

} else {

[222] Fix | Delete

$script_urls[] = $src;

[223] Fix | Delete

}

[224] Fix | Delete

}

[225] Fix | Delete

return $script_urls;

[226] Fix | Delete

}

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete