1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
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
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
|
<?php
/**
* WooCommerce Settings.
*/
declare( strict_types = 1 );
namespace Automattic\WooCommerce\Admin\Features\Settings;
use Automattic\WooCommerce\Internal\Admin\WCAdminAssets;
/**
* Contains backend logic for the Settings feature.
*/
class Init {
/**
* Class instance.
*
* @var Init instance
*/
protected static $instance = null;
/**
* Get class instance.
*/
public static function get_instance() {
if ( ! self::$instance ) {
self::$instance = new self();
}
return self::$instance;
}
/**
* Hook into WooCommerce.
*/
public function __construct() {
if ( ! is_admin() ) {
return;
}
add_filter( 'woocommerce_admin_shared_settings', array( __CLASS__, 'add_component_settings' ) );
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_settings_editor_scripts' ) );
add_action( 'admin_enqueue_scripts', array( $this, 'enqueue_settings_editor_styles' ) );
}
/**
* Check if the current screen is the WooCommerce settings page.
*
* @return bool
*/
public function is_settings_page() {
$screen = get_current_screen();
return $screen && 'woocommerce_page_wc-settings' === $screen->id;
}
/**
* Enqueue styles for the settings editor.
*/
public function enqueue_settings_editor_styles() {
if ( ! self::get_instance()->is_settings_page() ) {
return;
}
$style_name = 'wc-admin-edit-settings';
$style_path_name = 'settings';
$style_assets_filename = WCAdminAssets::get_script_asset_filename( $style_path_name, 'style' );
$style_assets = require WC_ADMIN_ABSPATH . WC_ADMIN_DIST_JS_FOLDER . $style_path_name . '/' . $style_assets_filename;
// Settings Editor styles.
wp_register_style(
$style_name,
WCAdminAssets::get_url( $style_path_name . '/style', 'css' ),
// Manually set dependencies for now, because the asset file is not being generated correctly.
// See plugins/woocommerce/assets/client/admin/settings-editor/style.asset.php. Should be: `isset( $style_assets['dependencies'] ) ? $style_assets['dependencies'] : array(),`.
array( 'wp-components', 'wc-components' ),
WCAdminAssets::get_file_version( 'css', $style_assets['version'] ),
);
wp_enqueue_style( $style_name );
// Global presets styles.
wp_register_style( 'wc-global-presets', false ); // phpcs:ignore
wp_add_inline_style( 'wc-global-presets', wp_get_global_stylesheet( array( 'presets' ) ) );
wp_enqueue_style( 'wc-global-presets' );
}
/**
* Enqueue scripts for the settings editor.
*/
public function enqueue_settings_editor_scripts() {
if ( ! self::get_instance()->is_settings_page() ) {
return;
}
// Make sure the Settings Editor package is loaded.
wp_enqueue_script( 'wc-settings-editor' );
wp_enqueue_style( 'wc-settings-editor' );
$script_name = 'wc-admin-edit-settings';
$script_path_name = 'settings';
$script_assets_filename = WCAdminAssets::get_script_asset_filename( $script_path_name, 'index' );
$script_assets = require WC_ADMIN_ABSPATH . WC_ADMIN_DIST_JS_FOLDER . $script_path_name . '/' . $script_assets_filename;
wp_enqueue_script(
$script_name,
WCAdminAssets::get_url( $script_path_name . '/index', 'js' ),
$script_assets['dependencies'],
WCAdminAssets::get_file_version( 'js', $script_assets['version'] ),
true
);
wp_set_script_translations( 'wc-admin-' . $script_name, 'woocommerce' );
}
/**
* Add the necessary data to initially load the WooCommerce Settings pages.
*
* @param array $settings Array of component settings.
* @return array Array of component settings.
*/
public static function add_component_settings( $settings ) {
if ( ! self::get_instance()->is_settings_page() ) {
return $settings;
}
global $wp_scripts;
// Set the scripts that all settings pages should have.
$ignored_settings_scripts = array(
'wc-admin-app',
'woocommerce_admin',
'wc-settings-editor',
'wc-admin-edit-settings',
'woo-tracks',
'woocommerce-admin-test-helper',
'woocommerce-beta-tester-live-branches',
'WCPAY_DASH_APP',
);
$default_scripts_handles = array_diff(
$wp_scripts->queue,
$ignored_settings_scripts,
);
$settings['settingsScripts']['_default'] = self::get_script_urls( $default_scripts_handles );
// Add the settings data to the settings array.
$setting_pages = \WC_Admin_Settings::get_settings_pages();
$settings = self::get_page_data( $settings, $setting_pages );
return $settings;
}
/**
* Get the page data for the settings editor.
*
* @param array $settings The settings array.
* @param array $setting_pages The setting pages.
* @return array The settings array.
*/
public static function get_page_data( $settings, $setting_pages ) {
global $wp_scripts;
/**
* Filters the settings tabs array.
*
* @since 2.5.0
*
* @param array $available_pages The available pages.
*/
$available_pages = apply_filters( 'woocommerce_settings_tabs_array', array() );
$pages = array();
foreach ( $setting_pages as $setting_page ) {
// If any page has removed itself from the tabs array, avoid adding this page to the settings editor.
if ( ! in_array( $setting_page->get_id(), array_keys( $available_pages ), true ) ) {
continue;
}
$scripts_before_adding_settings = $wp_scripts->queue;
$pages = $setting_page->add_settings_page_data( $pages );
$settings_scripts_handles = array_diff( $wp_scripts->queue, $scripts_before_adding_settings );
$settings['settingsScripts'][ $setting_page->get_id() ] = self::get_script_urls( $settings_scripts_handles );
}
$transformer = new Transformer();
$settings['settingsData']['pages'] = $transformer->transform( $pages );
$settings['settingsData']['start'] = $setting_pages[0]->get_custom_view( 'woocommerce_settings_start' );
$settings['settingsData']['_wpnonce'] = wp_create_nonce( 'wp_rest' );
return $settings;
}
/**
* Retrieve the script URLs from the provided script handles.
* This will also filter out scripts from WordPress core since they only need to be loaded once.
*
* @param array $script_handles Array of script handles.
* @return array Array of script URLs.
*/
private static function get_script_urls( $script_handles ) {
global $wp_scripts;
$script_urls = array();
foreach ( $script_handles as $script ) {
$registered_script = $wp_scripts->registered[ $script ];
if ( ! isset( $registered_script->src ) ) {
continue;
}
// Skip scripts from WordPress core since they only need to be loaded once.
if ( strpos( $registered_script->src, '/' . WPINC . '/js' ) === 0 || strpos( $registered_script->src, '/wp-admin/js' ) === 0 ) {
continue;
}
$src = $registered_script->src;
$ver = $registered_script->ver ? $registered_script->ver : false;
// Add version query parameter.
if ( $ver ) {
$src = add_query_arg( 'ver', $ver, $src );
}
// Add home URL if the src is a relative path.
if ( strpos( $src, '/' ) === 0 ) {
$script_urls[] = home_url( $src );
} else {
$script_urls[] = $src;
}
}
return $script_urls;
}
}
|