| author | ymh <ymh.work@gmail.com> |
| Tue, 15 Dec 2020 13:49:49 +0100 | |
| changeset 16 | a86126ab1dd4 |
| parent 9 | 177826044cd9 |
| child 18 | be944660c56a |
| permissions | -rw-r--r-- |
| 5 | 1 |
<?php |
2 |
/** |
|
3 |
* WordPress Customize Widgets classes |
|
4 |
* |
|
5 |
* @package WordPress |
|
6 |
* @subpackage Customize |
|
7 |
* @since 3.9.0 |
|
8 |
*/ |
|
9 |
||
10 |
/** |
|
11 |
* Customize Widgets class. |
|
12 |
* |
|
13 |
* Implements widget management in the Customizer. |
|
14 |
* |
|
15 |
* @since 3.9.0 |
|
16 |
* |
|
17 |
* @see WP_Customize_Manager |
|
18 |
*/ |
|
19 |
final class WP_Customize_Widgets { |
|
20 |
||
21 |
/** |
|
22 |
* WP_Customize_Manager instance. |
|
23 |
* |
|
24 |
* @since 3.9.0 |
|
25 |
* @var WP_Customize_Manager |
|
26 |
*/ |
|
27 |
public $manager; |
|
28 |
||
29 |
/** |
|
30 |
* All id_bases for widgets defined in core. |
|
31 |
* |
|
32 |
* @since 3.9.0 |
|
33 |
* @var array |
|
34 |
*/ |
|
35 |
protected $core_widget_id_bases = array( |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
36 |
'archives', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
37 |
'calendar', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
38 |
'categories', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
39 |
'custom_html', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
40 |
'links', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
41 |
'media_audio', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
42 |
'media_image', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
43 |
'media_video', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
44 |
'meta', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
45 |
'nav_menu', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
46 |
'pages', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
47 |
'recent-comments', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
48 |
'recent-posts', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
49 |
'rss', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
50 |
'search', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
51 |
'tag_cloud', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
52 |
'text', |
| 5 | 53 |
); |
54 |
||
55 |
/** |
|
56 |
* @since 3.9.0 |
|
57 |
* @var array |
|
58 |
*/ |
|
59 |
protected $rendered_sidebars = array(); |
|
60 |
||
61 |
/** |
|
62 |
* @since 3.9.0 |
|
63 |
* @var array |
|
64 |
*/ |
|
65 |
protected $rendered_widgets = array(); |
|
66 |
||
67 |
/** |
|
68 |
* @since 3.9.0 |
|
69 |
* @var array |
|
70 |
*/ |
|
71 |
protected $old_sidebars_widgets = array(); |
|
72 |
||
73 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
74 |
* Mapping of widget ID base to whether it supports selective refresh. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
75 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
76 |
* @since 4.5.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
77 |
* @var array |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
78 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
79 |
protected $selective_refreshable_widgets; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
80 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
81 |
/** |
| 5 | 82 |
* Mapping of setting type to setting ID pattern. |
83 |
* |
|
84 |
* @since 4.2.0 |
|
85 |
* @var array |
|
86 |
*/ |
|
87 |
protected $setting_id_patterns = array( |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
88 |
'widget_instance' => '/^widget_(?P<id_base>.+?)(?:\[(?P<widget_number>\d+)\])?$/', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
89 |
'sidebar_widgets' => '/^sidebars_widgets\[(?P<sidebar_id>.+?)\]$/', |
| 5 | 90 |
); |
91 |
||
92 |
/** |
|
93 |
* Initial loader. |
|
94 |
* |
|
95 |
* @since 3.9.0 |
|
96 |
* |
|
| 16 | 97 |
* @param WP_Customize_Manager $manager Customizer bootstrap instance. |
| 5 | 98 |
*/ |
99 |
public function __construct( $manager ) { |
|
100 |
$this->manager = $manager; |
|
101 |
||
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
102 |
// See https://github.com/xwp/wp-customize-snapshots/blob/962586659688a5b1fd9ae93618b7ce2d4e7a421c/php/class-customize-snapshot-manager.php#L420-L449 |
| 9 | 103 |
add_filter( 'customize_dynamic_setting_args', array( $this, 'filter_customize_dynamic_setting_args' ), 10, 2 ); |
104 |
add_action( 'widgets_init', array( $this, 'register_settings' ), 95 ); |
|
105 |
add_action( 'customize_register', array( $this, 'schedule_customize_register' ), 1 ); |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
106 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
107 |
// Skip remaining hooks when the user can't manage widgets anyway. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
108 |
if ( ! current_user_can( 'edit_theme_options' ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
109 |
return; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
110 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
111 |
|
| 9 | 112 |
add_action( 'wp_loaded', array( $this, 'override_sidebars_widgets_for_theme_switch' ) ); |
113 |
add_action( 'customize_controls_init', array( $this, 'customize_controls_init' ) ); |
|
114 |
add_action( 'customize_controls_enqueue_scripts', array( $this, 'enqueue_scripts' ) ); |
|
115 |
add_action( 'customize_controls_print_styles', array( $this, 'print_styles' ) ); |
|
116 |
add_action( 'customize_controls_print_scripts', array( $this, 'print_scripts' ) ); |
|
| 5 | 117 |
add_action( 'customize_controls_print_footer_scripts', array( $this, 'print_footer_scripts' ) ); |
118 |
add_action( 'customize_controls_print_footer_scripts', array( $this, 'output_widget_control_templates' ) ); |
|
| 9 | 119 |
add_action( 'customize_preview_init', array( $this, 'customize_preview_init' ) ); |
120 |
add_filter( 'customize_refresh_nonces', array( $this, 'refresh_nonces' ) ); |
|
| 5 | 121 |
|
| 9 | 122 |
add_action( 'dynamic_sidebar', array( $this, 'tally_rendered_widgets' ) ); |
123 |
add_filter( 'is_active_sidebar', array( $this, 'tally_sidebars_via_is_active_sidebar_calls' ), 10, 2 ); |
|
124 |
add_filter( 'dynamic_sidebar_has_widgets', array( $this, 'tally_sidebars_via_dynamic_sidebar_calls' ), 10, 2 ); |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
125 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
126 |
// Selective Refresh. |
| 9 | 127 |
add_filter( 'customize_dynamic_partial_args', array( $this, 'customize_dynamic_partial_args' ), 10, 2 ); |
128 |
add_action( 'customize_preview_init', array( $this, 'selective_refresh_init' ) ); |
|
| 5 | 129 |
} |
130 |
||
131 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
132 |
* List whether each registered widget can be use selective refresh. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
133 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
134 |
* If the theme does not support the customize-selective-refresh-widgets feature, |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
135 |
* then this will always return an empty array. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
136 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
137 |
* @since 4.5.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
138 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
139 |
* @global WP_Widget_Factory $wp_widget_factory |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
140 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
141 |
* @return array Mapping of id_base to support. If theme doesn't support |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
142 |
* selective refresh, an empty array is returned. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
143 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
144 |
public function get_selective_refreshable_widgets() { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
145 |
global $wp_widget_factory; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
146 |
if ( ! current_theme_supports( 'customize-selective-refresh-widgets' ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
147 |
return array(); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
148 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
149 |
if ( ! isset( $this->selective_refreshable_widgets ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
150 |
$this->selective_refreshable_widgets = array(); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
151 |
foreach ( $wp_widget_factory->widgets as $wp_widget ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
152 |
$this->selective_refreshable_widgets[ $wp_widget->id_base ] = ! empty( $wp_widget->widget_options['customize_selective_refresh'] ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
153 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
154 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
155 |
return $this->selective_refreshable_widgets; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
156 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
157 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
158 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
159 |
* Determines if a widget supports selective refresh. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
160 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
161 |
* @since 4.5.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
162 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
163 |
* @param string $id_base Widget ID Base. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
164 |
* @return bool Whether the widget can be selective refreshed. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
165 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
166 |
public function is_widget_selective_refreshable( $id_base ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
167 |
$selective_refreshable_widgets = $this->get_selective_refreshable_widgets(); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
168 |
return ! empty( $selective_refreshable_widgets[ $id_base ] ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
169 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
170 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
171 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
172 |
* Retrieves the widget setting type given a setting ID. |
| 5 | 173 |
* |
174 |
* @since 4.2.0 |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
175 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
176 |
* @param string $setting_id Setting ID. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
177 |
* @return string|void Setting type. |
| 5 | 178 |
*/ |
179 |
protected function get_setting_type( $setting_id ) { |
|
180 |
static $cache = array(); |
|
181 |
if ( isset( $cache[ $setting_id ] ) ) { |
|
182 |
return $cache[ $setting_id ]; |
|
183 |
} |
|
184 |
foreach ( $this->setting_id_patterns as $type => $pattern ) { |
|
185 |
if ( preg_match( $pattern, $setting_id ) ) { |
|
186 |
$cache[ $setting_id ] = $type; |
|
187 |
return $type; |
|
188 |
} |
|
189 |
} |
|
190 |
} |
|
191 |
||
192 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
193 |
* Inspects the incoming customized data for any widget settings, and dynamically adds |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
194 |
* them up-front so widgets will be initialized properly. |
| 5 | 195 |
* |
196 |
* @since 4.2.0 |
|
197 |
*/ |
|
198 |
public function register_settings() { |
|
| 9 | 199 |
$widget_setting_ids = array(); |
| 5 | 200 |
$incoming_setting_ids = array_keys( $this->manager->unsanitized_post_values() ); |
201 |
foreach ( $incoming_setting_ids as $setting_id ) { |
|
202 |
if ( ! is_null( $this->get_setting_type( $setting_id ) ) ) { |
|
203 |
$widget_setting_ids[] = $setting_id; |
|
204 |
} |
|
205 |
} |
|
206 |
if ( $this->manager->doing_ajax( 'update-widget' ) && isset( $_REQUEST['widget-id'] ) ) { |
|
207 |
$widget_setting_ids[] = $this->get_setting_id( wp_unslash( $_REQUEST['widget-id'] ) ); |
|
208 |
} |
|
209 |
||
210 |
$settings = $this->manager->add_dynamic_settings( array_unique( $widget_setting_ids ) ); |
|
211 |
||
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
212 |
if ( $this->manager->settings_previewed() ) { |
| 5 | 213 |
foreach ( $settings as $setting ) { |
214 |
$setting->preview(); |
|
215 |
} |
|
216 |
} |
|
217 |
} |
|
218 |
||
219 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
220 |
* Determines the arguments for a dynamically-created setting. |
| 5 | 221 |
* |
222 |
* @since 4.2.0 |
|
223 |
* |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
224 |
* @param false|array $args The arguments to the WP_Customize_Setting constructor. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
225 |
* @param string $setting_id ID for dynamic setting, usually coming from `$_POST['customized']`. |
| 16 | 226 |
* @return array|false Setting arguments, false otherwise. |
| 5 | 227 |
*/ |
228 |
public function filter_customize_dynamic_setting_args( $args, $setting_id ) { |
|
229 |
if ( $this->get_setting_type( $setting_id ) ) { |
|
230 |
$args = $this->get_setting_args( $setting_id ); |
|
231 |
} |
|
232 |
return $args; |
|
233 |
} |
|
234 |
||
235 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
236 |
* Retrieves an unslashed post value or return a default. |
| 5 | 237 |
* |
238 |
* @since 3.9.0 |
|
239 |
* |
|
240 |
* @param string $name Post value. |
|
241 |
* @param mixed $default Default post value. |
|
242 |
* @return mixed Unslashed post value or default value. |
|
243 |
*/ |
|
244 |
protected function get_post_value( $name, $default = null ) { |
|
245 |
if ( ! isset( $_POST[ $name ] ) ) { |
|
246 |
return $default; |
|
247 |
} |
|
248 |
||
249 |
return wp_unslash( $_POST[ $name ] ); |
|
250 |
} |
|
251 |
||
252 |
/** |
|
253 |
* Override sidebars_widgets for theme switch. |
|
254 |
* |
|
255 |
* When switching a theme via the Customizer, supply any previously-configured |
|
256 |
* sidebars_widgets from the target theme as the initial sidebars_widgets |
|
257 |
* setting. Also store the old theme's existing settings so that they can |
|
258 |
* be passed along for storing in the sidebars_widgets theme_mod when the |
|
259 |
* theme gets switched. |
|
260 |
* |
|
261 |
* @since 3.9.0 |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
262 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
263 |
* @global array $sidebars_widgets |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
264 |
* @global array $_wp_sidebars_widgets |
| 5 | 265 |
*/ |
266 |
public function override_sidebars_widgets_for_theme_switch() { |
|
267 |
global $sidebars_widgets; |
|
268 |
||
269 |
if ( $this->manager->doing_ajax() || $this->manager->is_theme_active() ) { |
|
270 |
return; |
|
271 |
} |
|
272 |
||
273 |
$this->old_sidebars_widgets = wp_get_sidebars_widgets(); |
|
274 |
add_filter( 'customize_value_old_sidebars_widgets_data', array( $this, 'filter_customize_value_old_sidebars_widgets_data' ) ); |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
275 |
$this->manager->set_post_value( 'old_sidebars_widgets_data', $this->old_sidebars_widgets ); // Override any value cached in changeset. |
| 5 | 276 |
|
| 16 | 277 |
// retrieve_widgets() looks at the global $sidebars_widgets. |
| 5 | 278 |
$sidebars_widgets = $this->old_sidebars_widgets; |
279 |
$sidebars_widgets = retrieve_widgets( 'customize' ); |
|
280 |
add_filter( 'option_sidebars_widgets', array( $this, 'filter_option_sidebars_widgets_for_theme_switch' ), 1 ); |
|
| 16 | 281 |
// Reset global cache var used by wp_get_sidebars_widgets(). |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
282 |
unset( $GLOBALS['_wp_sidebars_widgets'] ); |
| 5 | 283 |
} |
284 |
||
285 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
286 |
* Filters old_sidebars_widgets_data Customizer setting. |
| 5 | 287 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
288 |
* When switching themes, filter the Customizer setting old_sidebars_widgets_data |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
289 |
* to supply initial $sidebars_widgets before they were overridden by retrieve_widgets(). |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
290 |
* The value for old_sidebars_widgets_data gets set in the old theme's sidebars_widgets |
| 5 | 291 |
* theme_mod. |
292 |
* |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
293 |
* @since 3.9.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
294 |
* |
| 5 | 295 |
* @see WP_Customize_Widgets::handle_theme_switch() |
296 |
* |
|
297 |
* @param array $old_sidebars_widgets |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
298 |
* @return array |
| 5 | 299 |
*/ |
300 |
public function filter_customize_value_old_sidebars_widgets_data( $old_sidebars_widgets ) { |
|
301 |
return $this->old_sidebars_widgets; |
|
302 |
} |
|
303 |
||
304 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
305 |
* Filters sidebars_widgets option for theme switch. |
| 5 | 306 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
307 |
* When switching themes, the retrieve_widgets() function is run when the Customizer initializes, |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
308 |
* and then the new sidebars_widgets here get supplied as the default value for the sidebars_widgets |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
309 |
* option. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
310 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
311 |
* @since 3.9.0 |
| 5 | 312 |
* |
313 |
* @see WP_Customize_Widgets::handle_theme_switch() |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
314 |
* @global array $sidebars_widgets |
| 5 | 315 |
* |
316 |
* @param array $sidebars_widgets |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
317 |
* @return array |
| 5 | 318 |
*/ |
319 |
public function filter_option_sidebars_widgets_for_theme_switch( $sidebars_widgets ) { |
|
| 9 | 320 |
$sidebars_widgets = $GLOBALS['sidebars_widgets']; |
| 5 | 321 |
$sidebars_widgets['array_version'] = 3; |
322 |
return $sidebars_widgets; |
|
323 |
} |
|
324 |
||
325 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
326 |
* Ensures all widgets get loaded into the Customizer. |
| 5 | 327 |
* |
328 |
* Note: these actions are also fired in wp_ajax_update_widget(). |
|
329 |
* |
|
330 |
* @since 3.9.0 |
|
331 |
*/ |
|
332 |
public function customize_controls_init() { |
|
333 |
/** This action is documented in wp-admin/includes/ajax-actions.php */ |
|
| 16 | 334 |
do_action( 'load-widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
| 5 | 335 |
|
336 |
/** This action is documented in wp-admin/includes/ajax-actions.php */ |
|
| 16 | 337 |
do_action( 'widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
| 5 | 338 |
|
339 |
/** This action is documented in wp-admin/widgets.php */ |
|
340 |
do_action( 'sidebar_admin_setup' ); |
|
341 |
} |
|
342 |
||
343 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
344 |
* Ensures widgets are available for all types of previews. |
| 5 | 345 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
346 |
* When in preview, hook to {@see 'customize_register'} for settings after WordPress is loaded |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
347 |
* so that all filters have been initialized (e.g. Widget Visibility). |
| 5 | 348 |
* |
349 |
* @since 3.9.0 |
|
350 |
*/ |
|
351 |
public function schedule_customize_register() { |
|
352 |
if ( is_admin() ) { |
|
353 |
$this->customize_register(); |
|
354 |
} else { |
|
355 |
add_action( 'wp', array( $this, 'customize_register' ) ); |
|
356 |
} |
|
357 |
} |
|
358 |
||
359 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
360 |
* Registers Customizer settings and controls for all sidebars and widgets. |
| 5 | 361 |
* |
362 |
* @since 3.9.0 |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
363 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
364 |
* @global array $wp_registered_widgets |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
365 |
* @global array $wp_registered_widget_controls |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
366 |
* @global array $wp_registered_sidebars |
| 5 | 367 |
*/ |
368 |
public function customize_register() { |
|
369 |
global $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_sidebars; |
|
370 |
||
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
371 |
add_filter( 'sidebars_widgets', array( $this, 'preview_sidebars_widgets' ), 1 ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
372 |
|
| 5 | 373 |
$sidebars_widgets = array_merge( |
374 |
array( 'wp_inactive_widgets' => array() ), |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
375 |
array_fill_keys( array_keys( $wp_registered_sidebars ), array() ), |
| 5 | 376 |
wp_get_sidebars_widgets() |
377 |
); |
|
378 |
||
379 |
$new_setting_ids = array(); |
|
380 |
||
381 |
/* |
|
382 |
* Register a setting for all widgets, including those which are active, |
|
383 |
* inactive, and orphaned since a widget may get suppressed from a sidebar |
|
384 |
* via a plugin (like Widget Visibility). |
|
385 |
*/ |
|
386 |
foreach ( array_keys( $wp_registered_widgets ) as $widget_id ) { |
|
387 |
$setting_id = $this->get_setting_id( $widget_id ); |
|
388 |
$setting_args = $this->get_setting_args( $setting_id ); |
|
389 |
if ( ! $this->manager->get_setting( $setting_id ) ) { |
|
390 |
$this->manager->add_setting( $setting_id, $setting_args ); |
|
391 |
} |
|
392 |
$new_setting_ids[] = $setting_id; |
|
393 |
} |
|
394 |
||
395 |
/* |
|
396 |
* Add a setting which will be supplied for the theme's sidebars_widgets |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
397 |
* theme_mod when the theme is switched. |
| 5 | 398 |
*/ |
399 |
if ( ! $this->manager->is_theme_active() ) { |
|
| 9 | 400 |
$setting_id = 'old_sidebars_widgets_data'; |
401 |
$setting_args = $this->get_setting_args( |
|
402 |
$setting_id, |
|
403 |
array( |
|
404 |
'type' => 'global_variable', |
|
405 |
'dirty' => true, |
|
406 |
) |
|
407 |
); |
|
| 5 | 408 |
$this->manager->add_setting( $setting_id, $setting_args ); |
409 |
} |
|
410 |
||
| 9 | 411 |
$this->manager->add_panel( |
412 |
'widgets', |
|
413 |
array( |
|
414 |
'type' => 'widgets', |
|
415 |
'title' => __( 'Widgets' ), |
|
416 |
'description' => __( 'Widgets are independent sections of content that can be placed into widgetized areas provided by your theme (commonly called sidebars).' ), |
|
417 |
'priority' => 110, |
|
418 |
'active_callback' => array( $this, 'is_panel_active' ), |
|
419 |
'auto_expand_sole_section' => true, |
|
420 |
) |
|
421 |
); |
|
| 5 | 422 |
|
423 |
foreach ( $sidebars_widgets as $sidebar_id => $sidebar_widget_ids ) { |
|
424 |
if ( empty( $sidebar_widget_ids ) ) { |
|
425 |
$sidebar_widget_ids = array(); |
|
426 |
} |
|
427 |
||
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
428 |
$is_registered_sidebar = is_registered_sidebar( $sidebar_id ); |
| 5 | 429 |
$is_inactive_widgets = ( 'wp_inactive_widgets' === $sidebar_id ); |
430 |
$is_active_sidebar = ( $is_registered_sidebar && ! $is_inactive_widgets ); |
|
431 |
||
432 |
// Add setting for managing the sidebar's widgets. |
|
433 |
if ( $is_registered_sidebar || $is_inactive_widgets ) { |
|
434 |
$setting_id = sprintf( 'sidebars_widgets[%s]', $sidebar_id ); |
|
435 |
$setting_args = $this->get_setting_args( $setting_id ); |
|
436 |
if ( ! $this->manager->get_setting( $setting_id ) ) { |
|
437 |
if ( ! $this->manager->is_theme_active() ) { |
|
438 |
$setting_args['dirty'] = true; |
|
439 |
} |
|
440 |
$this->manager->add_setting( $setting_id, $setting_args ); |
|
441 |
} |
|
442 |
$new_setting_ids[] = $setting_id; |
|
443 |
||
444 |
// Add section to contain controls. |
|
445 |
$section_id = sprintf( 'sidebar-widgets-%s', $sidebar_id ); |
|
446 |
if ( $is_active_sidebar ) { |
|
447 |
||
448 |
$section_args = array( |
|
| 9 | 449 |
'title' => $wp_registered_sidebars[ $sidebar_id ]['name'], |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
450 |
'description' => $wp_registered_sidebars[ $sidebar_id ]['description'], |
| 16 | 451 |
'priority' => array_search( $sidebar_id, array_keys( $wp_registered_sidebars ), true ), |
| 9 | 452 |
'panel' => 'widgets', |
453 |
'sidebar_id' => $sidebar_id, |
|
| 5 | 454 |
); |
455 |
||
456 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
457 |
* Filters Customizer widget section arguments for a given sidebar. |
| 5 | 458 |
* |
459 |
* @since 3.9.0 |
|
460 |
* |
|
461 |
* @param array $section_args Array of Customizer widget section arguments. |
|
462 |
* @param string $section_id Customizer section ID. |
|
463 |
* @param int|string $sidebar_id Sidebar ID. |
|
464 |
*/ |
|
465 |
$section_args = apply_filters( 'customizer_widgets_section_args', $section_args, $section_id, $sidebar_id ); |
|
466 |
||
467 |
$section = new WP_Customize_Sidebar_Section( $this->manager, $section_id, $section_args ); |
|
468 |
$this->manager->add_section( $section ); |
|
469 |
||
| 9 | 470 |
$control = new WP_Widget_Area_Customize_Control( |
471 |
$this->manager, |
|
472 |
$setting_id, |
|
473 |
array( |
|
474 |
'section' => $section_id, |
|
475 |
'sidebar_id' => $sidebar_id, |
|
476 |
'priority' => count( $sidebar_widget_ids ), // place 'Add Widget' and 'Reorder' buttons at end. |
|
477 |
) |
|
478 |
); |
|
| 5 | 479 |
$new_setting_ids[] = $setting_id; |
480 |
||
481 |
$this->manager->add_control( $control ); |
|
482 |
} |
|
483 |
} |
|
484 |
||
485 |
// Add a control for each active widget (located in a sidebar). |
|
486 |
foreach ( $sidebar_widget_ids as $i => $widget_id ) { |
|
487 |
||
488 |
// Skip widgets that may have gone away due to a plugin being deactivated. |
|
| 9 | 489 |
if ( ! $is_active_sidebar || ! isset( $wp_registered_widgets[ $widget_id ] ) ) { |
| 5 | 490 |
continue; |
491 |
} |
|
492 |
||
| 9 | 493 |
$registered_widget = $wp_registered_widgets[ $widget_id ]; |
| 5 | 494 |
$setting_id = $this->get_setting_id( $widget_id ); |
| 9 | 495 |
$id_base = $wp_registered_widget_controls[ $widget_id ]['id_base']; |
| 5 | 496 |
|
| 9 | 497 |
$control = new WP_Widget_Form_Customize_Control( |
498 |
$this->manager, |
|
499 |
$setting_id, |
|
500 |
array( |
|
501 |
'label' => $registered_widget['name'], |
|
502 |
'section' => $section_id, |
|
503 |
'sidebar_id' => $sidebar_id, |
|
504 |
'widget_id' => $widget_id, |
|
505 |
'widget_id_base' => $id_base, |
|
506 |
'priority' => $i, |
|
507 |
'width' => $wp_registered_widget_controls[ $widget_id ]['width'], |
|
508 |
'height' => $wp_registered_widget_controls[ $widget_id ]['height'], |
|
509 |
'is_wide' => $this->is_wide_widget( $widget_id ), |
|
510 |
) |
|
511 |
); |
|
| 5 | 512 |
$this->manager->add_control( $control ); |
513 |
} |
|
514 |
} |
|
515 |
||
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
516 |
if ( $this->manager->settings_previewed() ) { |
| 5 | 517 |
foreach ( $new_setting_ids as $new_setting_id ) { |
518 |
$this->manager->get_setting( $new_setting_id )->preview(); |
|
519 |
} |
|
520 |
} |
|
521 |
} |
|
522 |
||
523 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
524 |
* Determines whether the widgets panel is active, based on whether there are sidebars registered. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
525 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
526 |
* @since 4.4.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
527 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
528 |
* @see WP_Customize_Panel::$active_callback |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
529 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
530 |
* @global array $wp_registered_sidebars |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
531 |
* @return bool Active. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
532 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
533 |
public function is_panel_active() { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
534 |
global $wp_registered_sidebars; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
535 |
return ! empty( $wp_registered_sidebars ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
536 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
537 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
538 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
539 |
* Converts a widget_id into its corresponding Customizer setting ID (option name). |
| 5 | 540 |
* |
541 |
* @since 3.9.0 |
|
542 |
* |
|
543 |
* @param string $widget_id Widget ID. |
|
544 |
* @return string Maybe-parsed widget ID. |
|
545 |
*/ |
|
546 |
public function get_setting_id( $widget_id ) { |
|
547 |
$parsed_widget_id = $this->parse_widget_id( $widget_id ); |
|
548 |
$setting_id = sprintf( 'widget_%s', $parsed_widget_id['id_base'] ); |
|
549 |
||
550 |
if ( ! is_null( $parsed_widget_id['number'] ) ) { |
|
551 |
$setting_id .= sprintf( '[%d]', $parsed_widget_id['number'] ); |
|
552 |
} |
|
553 |
return $setting_id; |
|
554 |
} |
|
555 |
||
556 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
557 |
* Determines whether the widget is considered "wide". |
| 5 | 558 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
559 |
* Core widgets which may have controls wider than 250, but can still be shown |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
560 |
* in the narrow Customizer panel. The RSS and Text widgets in Core, for example, |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
561 |
* have widths of 400 and yet they still render fine in the Customizer panel. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
562 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
563 |
* This method will return all Core widgets as being not wide, but this can be |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
564 |
* overridden with the {@see 'is_wide_widget_in_customizer'} filter. |
| 5 | 565 |
* |
566 |
* @since 3.9.0 |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
567 |
* |
| 16 | 568 |
* @global array $wp_registered_widget_controls |
| 5 | 569 |
* |
570 |
* @param string $widget_id Widget ID. |
|
571 |
* @return bool Whether or not the widget is a "wide" widget. |
|
572 |
*/ |
|
573 |
public function is_wide_widget( $widget_id ) { |
|
574 |
global $wp_registered_widget_controls; |
|
575 |
||
576 |
$parsed_widget_id = $this->parse_widget_id( $widget_id ); |
|
| 9 | 577 |
$width = $wp_registered_widget_controls[ $widget_id ]['width']; |
| 16 | 578 |
$is_core = in_array( $parsed_widget_id['id_base'], $this->core_widget_id_bases, true ); |
| 5 | 579 |
$is_wide = ( $width > 250 && ! $is_core ); |
580 |
||
581 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
582 |
* Filters whether the given widget is considered "wide". |
| 5 | 583 |
* |
584 |
* @since 3.9.0 |
|
585 |
* |
|
586 |
* @param bool $is_wide Whether the widget is wide, Default false. |
|
587 |
* @param string $widget_id Widget ID. |
|
588 |
*/ |
|
589 |
return apply_filters( 'is_wide_widget_in_customizer', $is_wide, $widget_id ); |
|
590 |
} |
|
591 |
||
592 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
593 |
* Converts a widget ID into its id_base and number components. |
| 5 | 594 |
* |
595 |
* @since 3.9.0 |
|
596 |
* |
|
597 |
* @param string $widget_id Widget ID. |
|
598 |
* @return array Array containing a widget's id_base and number components. |
|
599 |
*/ |
|
600 |
public function parse_widget_id( $widget_id ) { |
|
601 |
$parsed = array( |
|
| 9 | 602 |
'number' => null, |
| 5 | 603 |
'id_base' => null, |
604 |
); |
|
605 |
||
606 |
if ( preg_match( '/^(.+)-(\d+)$/', $widget_id, $matches ) ) { |
|
607 |
$parsed['id_base'] = $matches[1]; |
|
608 |
$parsed['number'] = intval( $matches[2] ); |
|
609 |
} else { |
|
| 16 | 610 |
// Likely an old single widget. |
| 5 | 611 |
$parsed['id_base'] = $widget_id; |
612 |
} |
|
613 |
return $parsed; |
|
614 |
} |
|
615 |
||
616 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
617 |
* Converts a widget setting ID (option path) to its id_base and number components. |
| 5 | 618 |
* |
619 |
* @since 3.9.0 |
|
620 |
* |
|
621 |
* @param string $setting_id Widget setting ID. |
|
| 16 | 622 |
* @return array|WP_Error Array containing a widget's id_base and number components, |
| 5 | 623 |
* or a WP_Error object. |
624 |
*/ |
|
625 |
public function parse_widget_setting_id( $setting_id ) { |
|
626 |
if ( ! preg_match( '/^(widget_(.+?))(?:\[(\d+)\])?$/', $setting_id, $matches ) ) { |
|
627 |
return new WP_Error( 'widget_setting_invalid_id' ); |
|
628 |
} |
|
629 |
||
630 |
$id_base = $matches[2]; |
|
631 |
$number = isset( $matches[3] ) ? intval( $matches[3] ) : null; |
|
632 |
||
633 |
return compact( 'id_base', 'number' ); |
|
634 |
} |
|
635 |
||
636 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
637 |
* Calls admin_print_styles-widgets.php and admin_print_styles hooks to |
| 5 | 638 |
* allow custom styles from plugins. |
639 |
* |
|
640 |
* @since 3.9.0 |
|
641 |
*/ |
|
642 |
public function print_styles() { |
|
643 |
/** This action is documented in wp-admin/admin-header.php */ |
|
| 16 | 644 |
do_action( 'admin_print_styles-widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
| 5 | 645 |
|
646 |
/** This action is documented in wp-admin/admin-header.php */ |
|
647 |
do_action( 'admin_print_styles' ); |
|
648 |
} |
|
649 |
||
650 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
651 |
* Calls admin_print_scripts-widgets.php and admin_print_scripts hooks to |
| 5 | 652 |
* allow custom scripts from plugins. |
653 |
* |
|
654 |
* @since 3.9.0 |
|
655 |
*/ |
|
656 |
public function print_scripts() { |
|
657 |
/** This action is documented in wp-admin/admin-header.php */ |
|
| 16 | 658 |
do_action( 'admin_print_scripts-widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
| 5 | 659 |
|
660 |
/** This action is documented in wp-admin/admin-header.php */ |
|
661 |
do_action( 'admin_print_scripts' ); |
|
662 |
} |
|
663 |
||
664 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
665 |
* Enqueues scripts and styles for Customizer panel and export data to JavaScript. |
| 5 | 666 |
* |
667 |
* @since 3.9.0 |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
668 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
669 |
* @global WP_Scripts $wp_scripts |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
670 |
* @global array $wp_registered_sidebars |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
671 |
* @global array $wp_registered_widgets |
| 5 | 672 |
*/ |
673 |
public function enqueue_scripts() { |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
674 |
global $wp_scripts, $wp_registered_sidebars, $wp_registered_widgets; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
675 |
|
| 5 | 676 |
wp_enqueue_style( 'customize-widgets' ); |
677 |
wp_enqueue_script( 'customize-widgets' ); |
|
678 |
||
679 |
/** This action is documented in wp-admin/admin-header.php */ |
|
680 |
do_action( 'admin_enqueue_scripts', 'widgets.php' ); |
|
681 |
||
682 |
/* |
|
683 |
* Export available widgets with control_tpl removed from model |
|
684 |
* since plugins need templates to be in the DOM. |
|
685 |
*/ |
|
686 |
$available_widgets = array(); |
|
687 |
||
688 |
foreach ( $this->get_available_widgets() as $available_widget ) { |
|
689 |
unset( $available_widget['control_tpl'] ); |
|
690 |
$available_widgets[] = $available_widget; |
|
691 |
} |
|
692 |
||
693 |
$widget_reorder_nav_tpl = sprintf( |
|
694 |
'<div class="widget-reorder-nav"><span class="move-widget" tabindex="0">%1$s</span><span class="move-widget-down" tabindex="0">%2$s</span><span class="move-widget-up" tabindex="0">%3$s</span></div>', |
|
695 |
__( 'Move to another area…' ), |
|
696 |
__( 'Move down' ), |
|
697 |
__( 'Move up' ) |
|
698 |
); |
|
699 |
||
700 |
$move_widget_area_tpl = str_replace( |
|
701 |
array( '{description}', '{btn}' ), |
|
702 |
array( |
|
703 |
__( 'Select an area to move this widget into:' ), |
|
704 |
_x( 'Move', 'Move widget' ), |
|
705 |
), |
|
706 |
'<div class="move-widget-area"> |
|
707 |
<p class="description">{description}</p> |
|
708 |
<ul class="widget-area-select"> |
|
709 |
<% _.each( sidebars, function ( sidebar ){ %> |
|
710 |
<li class="" data-id="<%- sidebar.id %>" title="<%- sidebar.description %>" tabindex="0"><%- sidebar.name %></li> |
|
711 |
<% }); %> |
|
712 |
</ul> |
|
713 |
<div class="move-widget-actions"> |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
714 |
<button class="move-widget-btn button" type="button">{btn}</button> |
| 5 | 715 |
</div> |
716 |
</div>' |
|
717 |
); |
|
718 |
||
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
719 |
/* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
720 |
* Gather all strings in PHP that may be needed by JS on the client. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
721 |
* Once JS i18n is implemented (in #20491), this can be removed. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
722 |
*/ |
| 9 | 723 |
$some_non_rendered_areas_messages = array(); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
724 |
$some_non_rendered_areas_messages[1] = html_entity_decode( |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
725 |
__( 'Your theme has 1 other widget area, but this particular page doesn’t display it.' ), |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
726 |
ENT_QUOTES, |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
727 |
get_bloginfo( 'charset' ) |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
728 |
); |
| 9 | 729 |
$registered_sidebar_count = count( $wp_registered_sidebars ); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
730 |
for ( $non_rendered_count = 2; $non_rendered_count < $registered_sidebar_count; $non_rendered_count++ ) { |
| 9 | 731 |
$some_non_rendered_areas_messages[ $non_rendered_count ] = html_entity_decode( |
732 |
sprintf( |
|
| 16 | 733 |
/* translators: %s: The number of other widget areas registered but not rendered. */ |
| 9 | 734 |
_n( |
735 |
'Your theme has %s other widget area, but this particular page doesn’t display it.', |
|
736 |
'Your theme has %s other widget areas, but this particular page doesn’t display them.', |
|
737 |
$non_rendered_count |
|
738 |
), |
|
739 |
number_format_i18n( $non_rendered_count ) |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
740 |
), |
| 9 | 741 |
ENT_QUOTES, |
742 |
get_bloginfo( 'charset' ) |
|
743 |
); |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
744 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
745 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
746 |
if ( 1 === $registered_sidebar_count ) { |
| 9 | 747 |
$no_areas_shown_message = html_entity_decode( |
748 |
sprintf( |
|
749 |
__( 'Your theme has 1 widget area, but this particular page doesn’t display it.' ) |
|
750 |
), |
|
751 |
ENT_QUOTES, |
|
752 |
get_bloginfo( 'charset' ) |
|
753 |
); |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
754 |
} else { |
| 9 | 755 |
$no_areas_shown_message = html_entity_decode( |
756 |
sprintf( |
|
| 16 | 757 |
/* translators: %s: The total number of widget areas registered. */ |
| 9 | 758 |
_n( |
759 |
'Your theme has %s widget area, but this particular page doesn’t display it.', |
|
760 |
'Your theme has %s widget areas, but this particular page doesn’t display them.', |
|
761 |
$registered_sidebar_count |
|
762 |
), |
|
763 |
number_format_i18n( $registered_sidebar_count ) |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
764 |
), |
| 9 | 765 |
ENT_QUOTES, |
766 |
get_bloginfo( 'charset' ) |
|
767 |
); |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
768 |
} |
| 5 | 769 |
|
770 |
$settings = array( |
|
| 9 | 771 |
'registeredSidebars' => array_values( $wp_registered_sidebars ), |
772 |
'registeredWidgets' => $wp_registered_widgets, |
|
| 16 | 773 |
'availableWidgets' => $available_widgets, // @todo Merge this with registered_widgets. |
| 9 | 774 |
'l10n' => array( |
| 5 | 775 |
'saveBtnLabel' => __( 'Apply' ), |
776 |
'saveBtnTooltip' => __( 'Save and preview changes before publishing them.' ), |
|
777 |
'removeBtnLabel' => __( 'Remove' ), |
|
| 9 | 778 |
'removeBtnTooltip' => __( 'Keep widget settings and move it to the inactive widgets' ), |
| 5 | 779 |
'error' => __( 'An error has occurred. Please reload the page and try again.' ), |
780 |
'widgetMovedUp' => __( 'Widget moved up' ), |
|
781 |
'widgetMovedDown' => __( 'Widget moved down' ), |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
782 |
'navigatePreview' => __( 'You can navigate to other pages on your site while using the Customizer to view and edit the widgets displayed on those pages.' ), |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
783 |
'someAreasShown' => $some_non_rendered_areas_messages, |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
784 |
'noAreasShown' => $no_areas_shown_message, |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
785 |
'reorderModeOn' => __( 'Reorder mode enabled' ), |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
786 |
'reorderModeOff' => __( 'Reorder mode closed' ), |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
787 |
'reorderLabelOn' => esc_attr__( 'Reorder widgets' ), |
| 16 | 788 |
/* translators: %d: The number of widgets found. */ |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
789 |
'widgetsFound' => __( 'Number of widgets found: %d' ), |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
790 |
'noWidgetsFound' => __( 'No widgets found.' ), |
| 5 | 791 |
), |
| 9 | 792 |
'tpl' => array( |
| 5 | 793 |
'widgetReorderNav' => $widget_reorder_nav_tpl, |
794 |
'moveWidgetArea' => $move_widget_area_tpl, |
|
795 |
), |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
796 |
'selectiveRefreshableWidgets' => $this->get_selective_refreshable_widgets(), |
| 5 | 797 |
); |
798 |
||
799 |
foreach ( $settings['registeredWidgets'] as &$registered_widget ) { |
|
| 16 | 800 |
unset( $registered_widget['callback'] ); // May not be JSON-serializeable. |
| 5 | 801 |
} |
802 |
||
803 |
$wp_scripts->add_data( |
|
804 |
'customize-widgets', |
|
805 |
'data', |
|
806 |
sprintf( 'var _wpCustomizeWidgetsSettings = %s;', wp_json_encode( $settings ) ) |
|
807 |
); |
|
808 |
} |
|
809 |
||
810 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
811 |
* Renders the widget form control templates into the DOM. |
| 5 | 812 |
* |
813 |
* @since 3.9.0 |
|
814 |
*/ |
|
815 |
public function output_widget_control_templates() { |
|
816 |
?> |
|
817 |
<div id="widgets-left"><!-- compatibility with JS which looks for widget templates here --> |
|
818 |
<div id="available-widgets"> |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
819 |
<div class="customize-section-title"> |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
820 |
<button class="customize-section-back" tabindex="-1"> |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
821 |
<span class="screen-reader-text"><?php _e( 'Back' ); ?></span> |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
822 |
</button> |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
823 |
<h3> |
| 9 | 824 |
<span class="customize-action"> |
825 |
<?php |
|
| 16 | 826 |
/* translators: ▸ is the unicode right-pointing triangle. %s: Section title in the Customizer. */ |
827 |
printf( __( 'Customizing ▸ %s' ), esc_html( $this->manager->get_panel( 'widgets' )->title ) ); |
|
| 9 | 828 |
?> |
829 |
</span> |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
830 |
<?php _e( 'Add a Widget' ); ?> |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
831 |
</h3> |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
832 |
</div> |
| 5 | 833 |
<div id="available-widgets-filter"> |
834 |
<label class="screen-reader-text" for="widgets-search"><?php _e( 'Search Widgets' ); ?></label> |
|
| 9 | 835 |
<input type="text" id="widgets-search" placeholder="<?php esc_attr_e( 'Search widgets…' ); ?>" aria-describedby="widgets-search-desc" /> |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
836 |
<div class="search-icon" aria-hidden="true"></div> |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
837 |
<button type="button" class="clear-results"><span class="screen-reader-text"><?php _e( 'Clear Results' ); ?></span></button> |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
838 |
<p class="screen-reader-text" id="widgets-search-desc"><?php _e( 'The search results will be updated as you type.' ); ?></p> |
| 5 | 839 |
</div> |
840 |
<div id="available-widgets-list"> |
|
| 9 | 841 |
<?php foreach ( $this->get_available_widgets() as $available_widget ) : ?> |
842 |
<div id="widget-tpl-<?php echo esc_attr( $available_widget['id'] ); ?>" data-widget-id="<?php echo esc_attr( $available_widget['id'] ); ?>" class="widget-tpl <?php echo esc_attr( $available_widget['id'] ); ?>" tabindex="0"> |
|
| 5 | 843 |
<?php echo $available_widget['control_tpl']; ?> |
844 |
</div> |
|
845 |
<?php endforeach; ?> |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
846 |
<p class="no-widgets-found-message"><?php _e( 'No widgets found.' ); ?></p> |
| 5 | 847 |
</div><!-- #available-widgets-list --> |
848 |
</div><!-- #available-widgets --> |
|
849 |
</div><!-- #widgets-left --> |
|
850 |
<?php |
|
851 |
} |
|
852 |
||
853 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
854 |
* Calls admin_print_footer_scripts and admin_print_scripts hooks to |
| 5 | 855 |
* allow custom scripts from plugins. |
856 |
* |
|
857 |
* @since 3.9.0 |
|
858 |
*/ |
|
859 |
public function print_footer_scripts() { |
|
860 |
/** This action is documented in wp-admin/admin-footer.php */ |
|
| 16 | 861 |
do_action( 'admin_print_footer_scripts-widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
862 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
863 |
/** This action is documented in wp-admin/admin-footer.php */ |
| 5 | 864 |
do_action( 'admin_print_footer_scripts' ); |
865 |
||
866 |
/** This action is documented in wp-admin/admin-footer.php */ |
|
| 16 | 867 |
do_action( 'admin_footer-widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
| 5 | 868 |
} |
869 |
||
870 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
871 |
* Retrieves common arguments to supply when constructing a Customizer setting. |
| 5 | 872 |
* |
873 |
* @since 3.9.0 |
|
874 |
* |
|
875 |
* @param string $id Widget setting ID. |
|
876 |
* @param array $overrides Array of setting overrides. |
|
877 |
* @return array Possibly modified setting arguments. |
|
878 |
*/ |
|
879 |
public function get_setting_args( $id, $overrides = array() ) { |
|
880 |
$args = array( |
|
881 |
'type' => 'option', |
|
882 |
'capability' => 'edit_theme_options', |
|
883 |
'default' => array(), |
|
884 |
); |
|
885 |
||
886 |
if ( preg_match( $this->setting_id_patterns['sidebar_widgets'], $id, $matches ) ) { |
|
| 9 | 887 |
$args['sanitize_callback'] = array( $this, 'sanitize_sidebar_widgets' ); |
| 5 | 888 |
$args['sanitize_js_callback'] = array( $this, 'sanitize_sidebar_widgets_js_instance' ); |
| 9 | 889 |
$args['transport'] = current_theme_supports( 'customize-selective-refresh-widgets' ) ? 'postMessage' : 'refresh'; |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
890 |
} elseif ( preg_match( $this->setting_id_patterns['widget_instance'], $id, $matches ) ) { |
| 9 | 891 |
$args['sanitize_callback'] = array( $this, 'sanitize_widget_instance' ); |
| 5 | 892 |
$args['sanitize_js_callback'] = array( $this, 'sanitize_widget_js_instance' ); |
| 9 | 893 |
$args['transport'] = $this->is_widget_selective_refreshable( $matches['id_base'] ) ? 'postMessage' : 'refresh'; |
| 5 | 894 |
} |
895 |
||
896 |
$args = array_merge( $args, $overrides ); |
|
897 |
||
898 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
899 |
* Filters the common arguments supplied when constructing a Customizer setting. |
| 5 | 900 |
* |
901 |
* @since 3.9.0 |
|
902 |
* |
|
903 |
* @see WP_Customize_Setting |
|
904 |
* |
|
905 |
* @param array $args Array of Customizer setting arguments. |
|
906 |
* @param string $id Widget setting ID. |
|
907 |
*/ |
|
908 |
return apply_filters( 'widget_customizer_setting_args', $args, $id ); |
|
909 |
} |
|
910 |
||
911 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
912 |
* Ensures sidebar widget arrays only ever contain widget IDS. |
| 5 | 913 |
* |
914 |
* Used as the 'sanitize_callback' for each $sidebars_widgets setting. |
|
915 |
* |
|
916 |
* @since 3.9.0 |
|
917 |
* |
|
| 9 | 918 |
* @param string[] $widget_ids Array of widget IDs. |
919 |
* @return string[] Array of sanitized widget IDs. |
|
| 5 | 920 |
*/ |
921 |
public function sanitize_sidebar_widgets( $widget_ids ) { |
|
| 9 | 922 |
$widget_ids = array_map( 'strval', (array) $widget_ids ); |
| 5 | 923 |
$sanitized_widget_ids = array(); |
924 |
foreach ( $widget_ids as $widget_id ) { |
|
925 |
$sanitized_widget_ids[] = preg_replace( '/[^a-z0-9_\-]/', '', $widget_id ); |
|
926 |
} |
|
927 |
return $sanitized_widget_ids; |
|
928 |
} |
|
929 |
||
930 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
931 |
* Builds up an index of all available widgets for use in Backbone models. |
| 5 | 932 |
* |
933 |
* @since 3.9.0 |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
934 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
935 |
* @global array $wp_registered_widgets |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
936 |
* @global array $wp_registered_widget_controls |
| 5 | 937 |
* |
938 |
* @see wp_list_widgets() |
|
939 |
* |
|
940 |
* @return array List of available widgets. |
|
941 |
*/ |
|
942 |
public function get_available_widgets() { |
|
943 |
static $available_widgets = array(); |
|
944 |
if ( ! empty( $available_widgets ) ) { |
|
945 |
return $available_widgets; |
|
946 |
} |
|
947 |
||
948 |
global $wp_registered_widgets, $wp_registered_widget_controls; |
|
| 16 | 949 |
require_once ABSPATH . 'wp-admin/includes/widgets.php'; // For next_widget_id_number(). |
| 5 | 950 |
|
951 |
$sort = $wp_registered_widgets; |
|
952 |
usort( $sort, array( $this, '_sort_name_callback' ) ); |
|
953 |
$done = array(); |
|
954 |
||
955 |
foreach ( $sort as $widget ) { |
|
| 16 | 956 |
if ( in_array( $widget['callback'], $done, true ) ) { // We already showed this multi-widget. |
| 5 | 957 |
continue; |
958 |
} |
|
959 |
||
960 |
$sidebar = is_active_widget( $widget['callback'], $widget['id'], false, false ); |
|
961 |
$done[] = $widget['callback']; |
|
962 |
||
963 |
if ( ! isset( $widget['params'][0] ) ) { |
|
964 |
$widget['params'][0] = array(); |
|
965 |
} |
|
966 |
||
967 |
$available_widget = $widget; |
|
| 16 | 968 |
unset( $available_widget['callback'] ); // Not serializable to JSON. |
| 5 | 969 |
|
970 |
$args = array( |
|
971 |
'widget_id' => $widget['id'], |
|
972 |
'widget_name' => $widget['name'], |
|
973 |
'_display' => 'template', |
|
974 |
); |
|
975 |
||
976 |
$is_disabled = false; |
|
| 9 | 977 |
$is_multi_widget = ( isset( $wp_registered_widget_controls[ $widget['id'] ]['id_base'] ) && isset( $widget['params'][0]['number'] ) ); |
| 5 | 978 |
if ( $is_multi_widget ) { |
| 9 | 979 |
$id_base = $wp_registered_widget_controls[ $widget['id'] ]['id_base']; |
| 5 | 980 |
$args['_temp_id'] = "$id_base-__i__"; |
981 |
$args['_multi_num'] = next_widget_id_number( $id_base ); |
|
982 |
$args['_add'] = 'multi'; |
|
983 |
} else { |
|
984 |
$args['_add'] = 'single'; |
|
985 |
||
986 |
if ( $sidebar && 'wp_inactive_widgets' !== $sidebar ) { |
|
987 |
$is_disabled = true; |
|
988 |
} |
|
989 |
$id_base = $widget['id']; |
|
990 |
} |
|
991 |
||
| 9 | 992 |
$list_widget_controls_args = wp_list_widget_controls_dynamic_sidebar( |
993 |
array( |
|
994 |
0 => $args, |
|
995 |
1 => $widget['params'][0], |
|
996 |
) |
|
997 |
); |
|
998 |
$control_tpl = $this->get_widget_control( $list_widget_controls_args ); |
|
| 5 | 999 |
|
1000 |
// The properties here are mapped to the Backbone Widget model. |
|
| 9 | 1001 |
$available_widget = array_merge( |
1002 |
$available_widget, |
|
1003 |
array( |
|
1004 |
'temp_id' => isset( $args['_temp_id'] ) ? $args['_temp_id'] : null, |
|
1005 |
'is_multi' => $is_multi_widget, |
|
1006 |
'control_tpl' => $control_tpl, |
|
| 16 | 1007 |
'multi_number' => ( 'multi' === $args['_add'] ) ? $args['_multi_num'] : false, |
| 9 | 1008 |
'is_disabled' => $is_disabled, |
1009 |
'id_base' => $id_base, |
|
1010 |
'transport' => $this->is_widget_selective_refreshable( $id_base ) ? 'postMessage' : 'refresh', |
|
1011 |
'width' => $wp_registered_widget_controls[ $widget['id'] ]['width'], |
|
1012 |
'height' => $wp_registered_widget_controls[ $widget['id'] ]['height'], |
|
1013 |
'is_wide' => $this->is_wide_widget( $widget['id'] ), |
|
1014 |
) |
|
1015 |
); |
|
| 5 | 1016 |
|
1017 |
$available_widgets[] = $available_widget; |
|
1018 |
} |
|
1019 |
||
1020 |
return $available_widgets; |
|
1021 |
} |
|
1022 |
||
1023 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1024 |
* Naturally orders available widgets by name. |
| 5 | 1025 |
* |
1026 |
* @since 3.9.0 |
|
1027 |
* |
|
1028 |
* @param array $widget_a The first widget to compare. |
|
1029 |
* @param array $widget_b The second widget to compare. |
|
1030 |
* @return int Reorder position for the current widget comparison. |
|
1031 |
*/ |
|
1032 |
protected function _sort_name_callback( $widget_a, $widget_b ) { |
|
1033 |
return strnatcasecmp( $widget_a['name'], $widget_b['name'] ); |
|
1034 |
} |
|
1035 |
||
1036 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1037 |
* Retrieves the widget control markup. |
| 5 | 1038 |
* |
1039 |
* @since 3.9.0 |
|
1040 |
* |
|
1041 |
* @param array $args Widget control arguments. |
|
1042 |
* @return string Widget control form HTML markup. |
|
1043 |
*/ |
|
1044 |
public function get_widget_control( $args ) { |
|
| 9 | 1045 |
$args[0]['before_form'] = '<div class="form">'; |
1046 |
$args[0]['after_form'] = '</div><!-- .form -->'; |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1047 |
$args[0]['before_widget_content'] = '<div class="widget-content">'; |
| 9 | 1048 |
$args[0]['after_widget_content'] = '</div><!-- .widget-content -->'; |
| 5 | 1049 |
ob_start(); |
| 16 | 1050 |
wp_widget_control( ...$args ); |
| 5 | 1051 |
$control_tpl = ob_get_clean(); |
1052 |
return $control_tpl; |
|
1053 |
} |
|
1054 |
||
1055 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1056 |
* Retrieves the widget control markup parts. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1057 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1058 |
* @since 4.4.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1059 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1060 |
* @param array $args Widget control arguments. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1061 |
* @return array { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1062 |
* @type string $control Markup for widget control wrapping form. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1063 |
* @type string $content The contents of the widget form itself. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1064 |
* } |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1065 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1066 |
public function get_widget_control_parts( $args ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1067 |
$args[0]['before_widget_content'] = '<div class="widget-content">'; |
| 9 | 1068 |
$args[0]['after_widget_content'] = '</div><!-- .widget-content -->'; |
1069 |
$control_markup = $this->get_widget_control( $args ); |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1070 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1071 |
$content_start_pos = strpos( $control_markup, $args[0]['before_widget_content'] ); |
| 9 | 1072 |
$content_end_pos = strrpos( $control_markup, $args[0]['after_widget_content'] ); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1073 |
|
| 9 | 1074 |
$control = substr( $control_markup, 0, $content_start_pos + strlen( $args[0]['before_widget_content'] ) ); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1075 |
$control .= substr( $control_markup, $content_end_pos ); |
| 9 | 1076 |
$content = trim( |
1077 |
substr( |
|
1078 |
$control_markup, |
|
1079 |
$content_start_pos + strlen( $args[0]['before_widget_content'] ), |
|
1080 |
$content_end_pos - $content_start_pos - strlen( $args[0]['before_widget_content'] ) |
|
1081 |
) |
|
1082 |
); |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1083 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1084 |
return compact( 'control', 'content' ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1085 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1086 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1087 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1088 |
* Adds hooks for the Customizer preview. |
| 5 | 1089 |
* |
1090 |
* @since 3.9.0 |
|
1091 |
*/ |
|
1092 |
public function customize_preview_init() { |
|
1093 |
add_action( 'wp_enqueue_scripts', array( $this, 'customize_preview_enqueue' ) ); |
|
| 9 | 1094 |
add_action( 'wp_print_styles', array( $this, 'print_preview_css' ), 1 ); |
1095 |
add_action( 'wp_footer', array( $this, 'export_preview_data' ), 20 ); |
|
| 5 | 1096 |
} |
1097 |
||
1098 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1099 |
* Refreshes the nonce for widget updates. |
| 5 | 1100 |
* |
1101 |
* @since 4.2.0 |
|
1102 |
* |
|
| 16 | 1103 |
* @param array $nonces Array of nonces. |
1104 |
* @return array Array of nonces. |
|
| 5 | 1105 |
*/ |
1106 |
public function refresh_nonces( $nonces ) { |
|
1107 |
$nonces['update-widget'] = wp_create_nonce( 'update-widget' ); |
|
1108 |
return $nonces; |
|
1109 |
} |
|
1110 |
||
1111 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1112 |
* When previewing, ensures the proper previewing widgets are used. |
| 5 | 1113 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1114 |
* Because wp_get_sidebars_widgets() gets called early at {@see 'init' } (via |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1115 |
* wp_convert_widget_settings()) and can set global variable `$_wp_sidebars_widgets` |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1116 |
* to the value of `get_option( 'sidebars_widgets' )` before the Customizer preview |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1117 |
* filter is added, it has to be reset after the filter has been added. |
| 5 | 1118 |
* |
1119 |
* @since 3.9.0 |
|
1120 |
* |
|
1121 |
* @param array $sidebars_widgets List of widgets for the current sidebar. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1122 |
* @return array |
| 5 | 1123 |
*/ |
1124 |
public function preview_sidebars_widgets( $sidebars_widgets ) { |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1125 |
$sidebars_widgets = get_option( 'sidebars_widgets', array() ); |
| 5 | 1126 |
|
1127 |
unset( $sidebars_widgets['array_version'] ); |
|
1128 |
return $sidebars_widgets; |
|
1129 |
} |
|
1130 |
||
1131 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1132 |
* Enqueues scripts for the Customizer preview. |
| 5 | 1133 |
* |
1134 |
* @since 3.9.0 |
|
1135 |
*/ |
|
1136 |
public function customize_preview_enqueue() { |
|
1137 |
wp_enqueue_script( 'customize-preview-widgets' ); |
|
1138 |
} |
|
1139 |
||
1140 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1141 |
* Inserts default style for highlighted widget at early point so theme |
| 5 | 1142 |
* stylesheet can override. |
1143 |
* |
|
1144 |
* @since 3.9.0 |
|
1145 |
*/ |
|
1146 |
public function print_preview_css() { |
|
1147 |
?> |
|
1148 |
<style> |
|
1149 |
.widget-customizer-highlighted-widget { |
|
1150 |
outline: none; |
|
| 9 | 1151 |
-webkit-box-shadow: 0 0 2px rgba(30, 140, 190, 0.8); |
1152 |
box-shadow: 0 0 2px rgba(30, 140, 190, 0.8); |
|
| 5 | 1153 |
position: relative; |
1154 |
z-index: 1; |
|
1155 |
} |
|
1156 |
</style> |
|
1157 |
<?php |
|
1158 |
} |
|
1159 |
||
1160 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1161 |
* Communicates the sidebars that appeared on the page at the very end of the page, |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1162 |
* and at the very end of the wp_footer, |
| 5 | 1163 |
* |
1164 |
* @since 3.9.0 |
|
| 9 | 1165 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1166 |
* @global array $wp_registered_sidebars |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1167 |
* @global array $wp_registered_widgets |
| 5 | 1168 |
*/ |
1169 |
public function export_preview_data() { |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1170 |
global $wp_registered_sidebars, $wp_registered_widgets; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1171 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1172 |
$switched_locale = switch_to_locale( get_user_locale() ); |
| 16 | 1173 |
|
1174 |
$l10n = array( |
|
| 9 | 1175 |
'widgetTooltip' => __( 'Shift-click to edit this widget.' ), |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1176 |
); |
| 16 | 1177 |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1178 |
if ( $switched_locale ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1179 |
restore_previous_locale(); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1180 |
} |
| 5 | 1181 |
|
| 16 | 1182 |
$rendered_sidebars = array_filter( $this->rendered_sidebars ); |
1183 |
$rendered_widgets = array_filter( $this->rendered_widgets ); |
|
1184 |
||
| 5 | 1185 |
// Prepare Customizer settings to pass to JavaScript. |
1186 |
$settings = array( |
|
| 16 | 1187 |
'renderedSidebars' => array_fill_keys( array_keys( $rendered_sidebars ), true ), |
1188 |
'renderedWidgets' => array_fill_keys( array_keys( $rendered_widgets ), true ), |
|
| 9 | 1189 |
'registeredSidebars' => array_values( $wp_registered_sidebars ), |
1190 |
'registeredWidgets' => $wp_registered_widgets, |
|
1191 |
'l10n' => $l10n, |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1192 |
'selectiveRefreshableWidgets' => $this->get_selective_refreshable_widgets(), |
| 5 | 1193 |
); |
| 16 | 1194 |
|
| 5 | 1195 |
foreach ( $settings['registeredWidgets'] as &$registered_widget ) { |
| 16 | 1196 |
unset( $registered_widget['callback'] ); // May not be JSON-serializeable. |
| 5 | 1197 |
} |
1198 |
||
1199 |
?> |
|
1200 |
<script type="text/javascript"> |
|
1201 |
var _wpWidgetCustomizerPreviewSettings = <?php echo wp_json_encode( $settings ); ?>; |
|
1202 |
</script> |
|
1203 |
<?php |
|
1204 |
} |
|
1205 |
||
1206 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1207 |
* Tracks the widgets that were rendered. |
| 5 | 1208 |
* |
1209 |
* @since 3.9.0 |
|
1210 |
* |
|
1211 |
* @param array $widget Rendered widget to tally. |
|
1212 |
*/ |
|
1213 |
public function tally_rendered_widgets( $widget ) { |
|
1214 |
$this->rendered_widgets[ $widget['id'] ] = true; |
|
1215 |
} |
|
1216 |
||
1217 |
/** |
|
1218 |
* Determine if a widget is rendered on the page. |
|
1219 |
* |
|
1220 |
* @since 4.0.0 |
|
1221 |
* |
|
1222 |
* @param string $widget_id Widget ID to check. |
|
1223 |
* @return bool Whether the widget is rendered. |
|
1224 |
*/ |
|
1225 |
public function is_widget_rendered( $widget_id ) { |
|
| 16 | 1226 |
return ! empty( $this->rendered_widgets[ $widget_id ] ); |
| 5 | 1227 |
} |
1228 |
||
1229 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1230 |
* Determines if a sidebar is rendered on the page. |
| 5 | 1231 |
* |
1232 |
* @since 4.0.0 |
|
1233 |
* |
|
1234 |
* @param string $sidebar_id Sidebar ID to check. |
|
1235 |
* @return bool Whether the sidebar is rendered. |
|
1236 |
*/ |
|
1237 |
public function is_sidebar_rendered( $sidebar_id ) { |
|
| 16 | 1238 |
return ! empty( $this->rendered_sidebars[ $sidebar_id ] ); |
| 5 | 1239 |
} |
1240 |
||
1241 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1242 |
* Tallies the sidebars rendered via is_active_sidebar(). |
| 5 | 1243 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1244 |
* Keep track of the times that is_active_sidebar() is called in the template, |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1245 |
* and assume that this means that the sidebar would be rendered on the template |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1246 |
* if there were widgets populating it. |
| 5 | 1247 |
* |
1248 |
* @since 3.9.0 |
|
1249 |
* |
|
1250 |
* @param bool $is_active Whether the sidebar is active. |
|
1251 |
* @param string $sidebar_id Sidebar ID. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1252 |
* @return bool Whether the sidebar is active. |
| 5 | 1253 |
*/ |
1254 |
public function tally_sidebars_via_is_active_sidebar_calls( $is_active, $sidebar_id ) { |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1255 |
if ( is_registered_sidebar( $sidebar_id ) ) { |
| 16 | 1256 |
$this->rendered_sidebars[ $sidebar_id ] = true; |
| 5 | 1257 |
} |
| 16 | 1258 |
|
| 5 | 1259 |
/* |
1260 |
* We may need to force this to true, and also force-true the value |
|
1261 |
* for 'dynamic_sidebar_has_widgets' if we want to ensure that there |
|
1262 |
* is an area to drop widgets into, if the sidebar is empty. |
|
1263 |
*/ |
|
1264 |
return $is_active; |
|
1265 |
} |
|
1266 |
||
1267 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1268 |
* Tallies the sidebars rendered via dynamic_sidebar(). |
| 5 | 1269 |
* |
1270 |
* Keep track of the times that dynamic_sidebar() is called in the template, |
|
1271 |
* and assume this means the sidebar would be rendered on the template if |
|
1272 |
* there were widgets populating it. |
|
1273 |
* |
|
1274 |
* @since 3.9.0 |
|
1275 |
* |
|
1276 |
* @param bool $has_widgets Whether the current sidebar has widgets. |
|
1277 |
* @param string $sidebar_id Sidebar ID. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1278 |
* @return bool Whether the current sidebar has widgets. |
| 5 | 1279 |
*/ |
1280 |
public function tally_sidebars_via_dynamic_sidebar_calls( $has_widgets, $sidebar_id ) { |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1281 |
if ( is_registered_sidebar( $sidebar_id ) ) { |
| 16 | 1282 |
$this->rendered_sidebars[ $sidebar_id ] = true; |
| 5 | 1283 |
} |
1284 |
||
1285 |
/* |
|
1286 |
* We may need to force this to true, and also force-true the value |
|
1287 |
* for 'is_active_sidebar' if we want to ensure there is an area to |
|
1288 |
* drop widgets into, if the sidebar is empty. |
|
1289 |
*/ |
|
1290 |
return $has_widgets; |
|
1291 |
} |
|
1292 |
||
1293 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1294 |
* Retrieves MAC for a serialized widget instance string. |
| 5 | 1295 |
* |
1296 |
* Allows values posted back from JS to be rejected if any tampering of the |
|
1297 |
* data has occurred. |
|
1298 |
* |
|
1299 |
* @since 3.9.0 |
|
1300 |
* |
|
1301 |
* @param string $serialized_instance Widget instance. |
|
1302 |
* @return string MAC for serialized widget instance. |
|
1303 |
*/ |
|
1304 |
protected function get_instance_hash_key( $serialized_instance ) { |
|
1305 |
return wp_hash( $serialized_instance ); |
|
1306 |
} |
|
1307 |
||
1308 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1309 |
* Sanitizes a widget instance. |
| 5 | 1310 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1311 |
* Unserialize the JS-instance for storing in the options. It's important that this filter |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1312 |
* only get applied to an instance *once*. |
| 5 | 1313 |
* |
1314 |
* @since 3.9.0 |
|
1315 |
* |
|
1316 |
* @param array $value Widget instance to sanitize. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1317 |
* @return array|void Sanitized widget instance. |
| 5 | 1318 |
*/ |
1319 |
public function sanitize_widget_instance( $value ) { |
|
| 16 | 1320 |
if ( array() === $value ) { |
| 5 | 1321 |
return $value; |
1322 |
} |
|
1323 |
||
1324 |
if ( empty( $value['is_widget_customizer_js_value'] ) |
|
1325 |
|| empty( $value['instance_hash_key'] ) |
|
| 9 | 1326 |
|| empty( $value['encoded_serialized_instance'] ) ) { |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1327 |
return; |
| 5 | 1328 |
} |
1329 |
||
1330 |
$decoded = base64_decode( $value['encoded_serialized_instance'], true ); |
|
1331 |
if ( false === $decoded ) { |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1332 |
return; |
| 5 | 1333 |
} |
1334 |
||
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1335 |
if ( ! hash_equals( $this->get_instance_hash_key( $decoded ), $value['instance_hash_key'] ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1336 |
return; |
| 5 | 1337 |
} |
1338 |
||
1339 |
$instance = unserialize( $decoded ); |
|
1340 |
if ( false === $instance ) { |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1341 |
return; |
| 5 | 1342 |
} |
1343 |
||
1344 |
return $instance; |
|
1345 |
} |
|
1346 |
||
1347 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1348 |
* Converts a widget instance into JSON-representable format. |
| 5 | 1349 |
* |
1350 |
* @since 3.9.0 |
|
1351 |
* |
|
1352 |
* @param array $value Widget instance to convert to JSON. |
|
1353 |
* @return array JSON-converted widget instance. |
|
1354 |
*/ |
|
1355 |
public function sanitize_widget_js_instance( $value ) { |
|
1356 |
if ( empty( $value['is_widget_customizer_js_value'] ) ) { |
|
1357 |
$serialized = serialize( $value ); |
|
1358 |
||
1359 |
$value = array( |
|
1360 |
'encoded_serialized_instance' => base64_encode( $serialized ), |
|
1361 |
'title' => empty( $value['title'] ) ? '' : $value['title'], |
|
1362 |
'is_widget_customizer_js_value' => true, |
|
1363 |
'instance_hash_key' => $this->get_instance_hash_key( $serialized ), |
|
1364 |
); |
|
1365 |
} |
|
1366 |
return $value; |
|
1367 |
} |
|
1368 |
||
1369 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1370 |
* Strips out widget IDs for widgets which are no longer registered. |
| 5 | 1371 |
* |
1372 |
* One example where this might happen is when a plugin orphans a widget |
|
1373 |
* in a sidebar upon deactivation. |
|
1374 |
* |
|
1375 |
* @since 3.9.0 |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1376 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1377 |
* @global array $wp_registered_widgets |
| 5 | 1378 |
* |
1379 |
* @param array $widget_ids List of widget IDs. |
|
1380 |
* @return array Parsed list of widget IDs. |
|
1381 |
*/ |
|
1382 |
public function sanitize_sidebar_widgets_js_instance( $widget_ids ) { |
|
1383 |
global $wp_registered_widgets; |
|
1384 |
$widget_ids = array_values( array_intersect( $widget_ids, array_keys( $wp_registered_widgets ) ) ); |
|
1385 |
return $widget_ids; |
|
1386 |
} |
|
1387 |
||
1388 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1389 |
* Finds and invokes the widget update and control callbacks. |
| 5 | 1390 |
* |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1391 |
* Requires that `$_POST` be populated with the instance data. |
| 5 | 1392 |
* |
1393 |
* @since 3.9.0 |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1394 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1395 |
* @global array $wp_registered_widget_updates |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1396 |
* @global array $wp_registered_widget_controls |
| 5 | 1397 |
* |
| 16 | 1398 |
* @param string $widget_id Widget ID. |
1399 |
* @return array|WP_Error Array containing the updated widget information. |
|
| 5 | 1400 |
* A WP_Error object, otherwise. |
1401 |
*/ |
|
1402 |
public function call_widget_update( $widget_id ) { |
|
1403 |
global $wp_registered_widget_updates, $wp_registered_widget_controls; |
|
1404 |
||
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1405 |
$setting_id = $this->get_setting_id( $widget_id ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1406 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1407 |
/* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1408 |
* Make sure that other setting changes have previewed since this widget |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1409 |
* may depend on them (e.g. Menus being present for Navigation Menu widget). |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1410 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1411 |
if ( ! did_action( 'customize_preview_init' ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1412 |
foreach ( $this->manager->settings() as $setting ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1413 |
if ( $setting->id !== $setting_id ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1414 |
$setting->preview(); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1415 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1416 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1417 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1418 |
|
| 5 | 1419 |
$this->start_capturing_option_updates(); |
1420 |
$parsed_id = $this->parse_widget_id( $widget_id ); |
|
1421 |
$option_name = 'widget_' . $parsed_id['id_base']; |
|
1422 |
||
1423 |
/* |
|
1424 |
* If a previously-sanitized instance is provided, populate the input vars |
|
1425 |
* with its values so that the widget update callback will read this instance |
|
1426 |
*/ |
|
1427 |
$added_input_vars = array(); |
|
1428 |
if ( ! empty( $_POST['sanitized_widget_setting'] ) ) { |
|
1429 |
$sanitized_widget_setting = json_decode( $this->get_post_value( 'sanitized_widget_setting' ), true ); |
|
1430 |
if ( false === $sanitized_widget_setting ) { |
|
1431 |
$this->stop_capturing_option_updates(); |
|
1432 |
return new WP_Error( 'widget_setting_malformed' ); |
|
1433 |
} |
|
1434 |
||
1435 |
$instance = $this->sanitize_widget_instance( $sanitized_widget_setting ); |
|
1436 |
if ( is_null( $instance ) ) { |
|
1437 |
$this->stop_capturing_option_updates(); |
|
1438 |
return new WP_Error( 'widget_setting_unsanitized' ); |
|
1439 |
} |
|
1440 |
||
1441 |
if ( ! is_null( $parsed_id['number'] ) ) { |
|
| 9 | 1442 |
$value = array(); |
1443 |
$value[ $parsed_id['number'] ] = $instance; |
|
1444 |
$key = 'widget-' . $parsed_id['id_base']; |
|
| 16 | 1445 |
$_REQUEST[ $key ] = wp_slash( $value ); |
1446 |
$_POST[ $key ] = $_REQUEST[ $key ]; |
|
| 9 | 1447 |
$added_input_vars[] = $key; |
| 5 | 1448 |
} else { |
1449 |
foreach ( $instance as $key => $value ) { |
|
| 16 | 1450 |
$_REQUEST[ $key ] = wp_slash( $value ); |
1451 |
$_POST[ $key ] = $_REQUEST[ $key ]; |
|
| 5 | 1452 |
$added_input_vars[] = $key; |
1453 |
} |
|
1454 |
} |
|
1455 |
} |
|
1456 |
||
1457 |
// Invoke the widget update callback. |
|
1458 |
foreach ( (array) $wp_registered_widget_updates as $name => $control ) { |
|
1459 |
if ( $name === $parsed_id['id_base'] && is_callable( $control['callback'] ) ) { |
|
1460 |
ob_start(); |
|
1461 |
call_user_func_array( $control['callback'], $control['params'] ); |
|
1462 |
ob_end_clean(); |
|
1463 |
break; |
|
1464 |
} |
|
1465 |
} |
|
1466 |
||
| 16 | 1467 |
// Clean up any input vars that were manually added. |
| 5 | 1468 |
foreach ( $added_input_vars as $key ) { |
1469 |
unset( $_POST[ $key ] ); |
|
1470 |
unset( $_REQUEST[ $key ] ); |
|
1471 |
} |
|
1472 |
||
1473 |
// Make sure the expected option was updated. |
|
1474 |
if ( 0 !== $this->count_captured_options() ) { |
|
1475 |
if ( $this->count_captured_options() > 1 ) { |
|
1476 |
$this->stop_capturing_option_updates(); |
|
1477 |
return new WP_Error( 'widget_setting_too_many_options' ); |
|
1478 |
} |
|
1479 |
||
1480 |
$updated_option_name = key( $this->get_captured_options() ); |
|
1481 |
if ( $updated_option_name !== $option_name ) { |
|
1482 |
$this->stop_capturing_option_updates(); |
|
1483 |
return new WP_Error( 'widget_setting_unexpected_option' ); |
|
1484 |
} |
|
1485 |
} |
|
1486 |
||
1487 |
// Obtain the widget instance. |
|
1488 |
$option = $this->get_captured_option( $option_name ); |
|
1489 |
if ( null !== $parsed_id['number'] ) { |
|
1490 |
$instance = $option[ $parsed_id['number'] ]; |
|
1491 |
} else { |
|
1492 |
$instance = $option; |
|
1493 |
} |
|
1494 |
||
1495 |
/* |
|
1496 |
* Override the incoming $_POST['customized'] for a newly-created widget's |
|
1497 |
* setting with the new $instance so that the preview filter currently |
|
1498 |
* in place from WP_Customize_Setting::preview() will use this value |
|
1499 |
* instead of the default widget instance value (an empty array). |
|
1500 |
*/ |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1501 |
$this->manager->set_post_value( $setting_id, $this->sanitize_widget_js_instance( $instance ) ); |
| 5 | 1502 |
|
1503 |
// Obtain the widget control with the updated instance in place. |
|
1504 |
ob_start(); |
|
1505 |
$form = $wp_registered_widget_controls[ $widget_id ]; |
|
1506 |
if ( $form ) { |
|
1507 |
call_user_func_array( $form['callback'], $form['params'] ); |
|
1508 |
} |
|
1509 |
$form = ob_get_clean(); |
|
1510 |
||
1511 |
$this->stop_capturing_option_updates(); |
|
1512 |
||
1513 |
return compact( 'instance', 'form' ); |
|
1514 |
} |
|
1515 |
||
1516 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1517 |
* Updates widget settings asynchronously. |
| 5 | 1518 |
* |
1519 |
* Allows the Customizer to update a widget using its form, but return the new |
|
1520 |
* instance info via Ajax instead of saving it to the options table. |
|
1521 |
* |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1522 |
* Most code here copied from wp_ajax_save_widget(). |
| 5 | 1523 |
* |
1524 |
* @since 3.9.0 |
|
1525 |
* |
|
1526 |
* @see wp_ajax_save_widget() |
|
1527 |
*/ |
|
1528 |
public function wp_ajax_update_widget() { |
|
1529 |
||
1530 |
if ( ! is_user_logged_in() ) { |
|
1531 |
wp_die( 0 ); |
|
1532 |
} |
|
1533 |
||
1534 |
check_ajax_referer( 'update-widget', 'nonce' ); |
|
1535 |
||
1536 |
if ( ! current_user_can( 'edit_theme_options' ) ) { |
|
1537 |
wp_die( -1 ); |
|
1538 |
} |
|
1539 |
||
1540 |
if ( empty( $_POST['widget-id'] ) ) { |
|
1541 |
wp_send_json_error( 'missing_widget-id' ); |
|
1542 |
} |
|
1543 |
||
1544 |
/** This action is documented in wp-admin/includes/ajax-actions.php */ |
|
| 16 | 1545 |
do_action( 'load-widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
| 5 | 1546 |
|
1547 |
/** This action is documented in wp-admin/includes/ajax-actions.php */ |
|
| 16 | 1548 |
do_action( 'widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores |
| 5 | 1549 |
|
1550 |
/** This action is documented in wp-admin/widgets.php */ |
|
1551 |
do_action( 'sidebar_admin_setup' ); |
|
1552 |
||
1553 |
$widget_id = $this->get_post_value( 'widget-id' ); |
|
1554 |
$parsed_id = $this->parse_widget_id( $widget_id ); |
|
| 9 | 1555 |
$id_base = $parsed_id['id_base']; |
| 5 | 1556 |
|
1557 |
$is_updating_widget_template = ( |
|
1558 |
isset( $_POST[ 'widget-' . $id_base ] ) |
|
1559 |
&& |
|
1560 |
is_array( $_POST[ 'widget-' . $id_base ] ) |
|
1561 |
&& |
|
1562 |
preg_match( '/__i__|%i%/', key( $_POST[ 'widget-' . $id_base ] ) ) |
|
1563 |
); |
|
1564 |
if ( $is_updating_widget_template ) { |
|
1565 |
wp_send_json_error( 'template_widget_not_updatable' ); |
|
1566 |
} |
|
1567 |
||
1568 |
$updated_widget = $this->call_widget_update( $widget_id ); // => {instance,form} |
|
1569 |
if ( is_wp_error( $updated_widget ) ) { |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1570 |
wp_send_json_error( $updated_widget->get_error_code() ); |
| 5 | 1571 |
} |
1572 |
||
| 9 | 1573 |
$form = $updated_widget['form']; |
| 5 | 1574 |
$instance = $this->sanitize_widget_js_instance( $updated_widget['instance'] ); |
1575 |
||
1576 |
wp_send_json_success( compact( 'form', 'instance' ) ); |
|
1577 |
} |
|
1578 |
||
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1579 |
/* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1580 |
* Selective Refresh Methods |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1581 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1582 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1583 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1584 |
* Filters arguments for dynamic widget partials. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1585 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1586 |
* @since 4.5.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1587 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1588 |
* @param array|false $partial_args Partial arguments. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1589 |
* @param string $partial_id Partial ID. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1590 |
* @return array (Maybe) modified partial arguments. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1591 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1592 |
public function customize_dynamic_partial_args( $partial_args, $partial_id ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1593 |
if ( ! current_theme_supports( 'customize-selective-refresh-widgets' ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1594 |
return $partial_args; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1595 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1596 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1597 |
if ( preg_match( '/^widget\[(?P<widget_id>.+)\]$/', $partial_id, $matches ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1598 |
if ( false === $partial_args ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1599 |
$partial_args = array(); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1600 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1601 |
$partial_args = array_merge( |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1602 |
$partial_args, |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1603 |
array( |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1604 |
'type' => 'widget', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1605 |
'render_callback' => array( $this, 'render_widget_partial' ), |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1606 |
'container_inclusive' => true, |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1607 |
'settings' => array( $this->get_setting_id( $matches['widget_id'] ) ), |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1608 |
'capability' => 'edit_theme_options', |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1609 |
) |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1610 |
); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1611 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1612 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1613 |
return $partial_args; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1614 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1615 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1616 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1617 |
* Adds hooks for selective refresh. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1618 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1619 |
* @since 4.5.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1620 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1621 |
public function selective_refresh_init() { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1622 |
if ( ! current_theme_supports( 'customize-selective-refresh-widgets' ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1623 |
return; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1624 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1625 |
add_filter( 'dynamic_sidebar_params', array( $this, 'filter_dynamic_sidebar_params' ) ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1626 |
add_filter( 'wp_kses_allowed_html', array( $this, 'filter_wp_kses_allowed_data_attributes' ) ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1627 |
add_action( 'dynamic_sidebar_before', array( $this, 'start_dynamic_sidebar' ) ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1628 |
add_action( 'dynamic_sidebar_after', array( $this, 'end_dynamic_sidebar' ) ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1629 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1630 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1631 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1632 |
* Inject selective refresh data attributes into widget container elements. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1633 |
* |
| 9 | 1634 |
* @since 4.5.0 |
1635 |
* |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1636 |
* @param array $params { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1637 |
* Dynamic sidebar params. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1638 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1639 |
* @type array $args Sidebar args. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1640 |
* @type array $widget_args Widget args. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1641 |
* } |
| 9 | 1642 |
* @see WP_Customize_Nav_Menus::filter_wp_nav_menu_args() |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1643 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1644 |
* @return array Params. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1645 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1646 |
public function filter_dynamic_sidebar_params( $params ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1647 |
$sidebar_args = array_merge( |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1648 |
array( |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1649 |
'before_widget' => '', |
| 9 | 1650 |
'after_widget' => '', |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1651 |
), |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1652 |
$params[0] |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1653 |
); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1654 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1655 |
// Skip widgets not in a registered sidebar or ones which lack a proper wrapper element to attach the data-* attributes to. |
| 9 | 1656 |
$matches = array(); |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1657 |
$is_valid = ( |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1658 |
isset( $sidebar_args['id'] ) |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1659 |
&& |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1660 |
is_registered_sidebar( $sidebar_args['id'] ) |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1661 |
&& |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1662 |
( isset( $this->current_dynamic_sidebar_id_stack[0] ) && $this->current_dynamic_sidebar_id_stack[0] === $sidebar_args['id'] ) |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1663 |
&& |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1664 |
preg_match( '#^<(?P<tag_name>\w+)#', $sidebar_args['before_widget'], $matches ) |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1665 |
); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1666 |
if ( ! $is_valid ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1667 |
return $params; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1668 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1669 |
$this->before_widget_tags_seen[ $matches['tag_name'] ] = true; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1670 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1671 |
$context = array( |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1672 |
'sidebar_id' => $sidebar_args['id'], |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1673 |
); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1674 |
if ( isset( $this->context_sidebar_instance_number ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1675 |
$context['sidebar_instance_number'] = $this->context_sidebar_instance_number; |
| 9 | 1676 |
} elseif ( isset( $sidebar_args['id'] ) && isset( $this->sidebar_instance_count[ $sidebar_args['id'] ] ) ) { |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1677 |
$context['sidebar_instance_number'] = $this->sidebar_instance_count[ $sidebar_args['id'] ]; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1678 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1679 |
|
| 9 | 1680 |
$attributes = sprintf( ' data-customize-partial-id="%s"', esc_attr( 'widget[' . $sidebar_args['widget_id'] . ']' ) ); |
1681 |
$attributes .= ' data-customize-partial-type="widget"'; |
|
1682 |
$attributes .= sprintf( ' data-customize-partial-placement-context="%s"', esc_attr( wp_json_encode( $context ) ) ); |
|
1683 |
$attributes .= sprintf( ' data-customize-widget-id="%s"', esc_attr( $sidebar_args['widget_id'] ) ); |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1684 |
$sidebar_args['before_widget'] = preg_replace( '#^(<\w+)#', '$1 ' . $attributes, $sidebar_args['before_widget'] ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1685 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1686 |
$params[0] = $sidebar_args; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1687 |
return $params; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1688 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1689 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1690 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1691 |
* List of the tag names seen for before_widget strings. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1692 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1693 |
* This is used in the {@see 'filter_wp_kses_allowed_html'} filter to ensure that the |
| 16 | 1694 |
* data-* attributes can be allowed. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1695 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1696 |
* @since 4.5.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1697 |
* @var array |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1698 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1699 |
protected $before_widget_tags_seen = array(); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1700 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1701 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1702 |
* Ensures the HTML data-* attributes for selective refresh are allowed by kses. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1703 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1704 |
* This is needed in case the `$before_widget` is run through wp_kses() when printed. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1705 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1706 |
* @since 4.5.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1707 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1708 |
* @param array $allowed_html Allowed HTML. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1709 |
* @return array (Maybe) modified allowed HTML. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1710 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1711 |
public function filter_wp_kses_allowed_data_attributes( $allowed_html ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1712 |
foreach ( array_keys( $this->before_widget_tags_seen ) as $tag_name ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1713 |
if ( ! isset( $allowed_html[ $tag_name ] ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1714 |
$allowed_html[ $tag_name ] = array(); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1715 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1716 |
$allowed_html[ $tag_name ] = array_merge( |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1717 |
$allowed_html[ $tag_name ], |
| 9 | 1718 |
array_fill_keys( |
1719 |
array( |
|
1720 |
'data-customize-partial-id', |
|
1721 |
'data-customize-partial-type', |
|
1722 |
'data-customize-partial-placement-context', |
|
1723 |
'data-customize-partial-widget-id', |
|
1724 |
'data-customize-partial-options', |
|
1725 |
), |
|
1726 |
true |
|
1727 |
) |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1728 |
); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1729 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1730 |
return $allowed_html; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1731 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1732 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1733 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1734 |
* Keep track of the number of times that dynamic_sidebar() was called for a given sidebar index. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1735 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1736 |
* This helps facilitate the uncommon scenario where a single sidebar is rendered multiple times on a template. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1737 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1738 |
* @since 4.5.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1739 |
* @var array |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1740 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1741 |
protected $sidebar_instance_count = array(); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1742 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1743 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1744 |
* The current request's sidebar_instance_number context. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1745 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1746 |
* @since 4.5.0 |
| 16 | 1747 |
* @var int|null |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1748 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1749 |
protected $context_sidebar_instance_number; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1750 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1751 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1752 |
* Current sidebar ID being rendered. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1753 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1754 |
* @since 4.5.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1755 |
* @var array |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1756 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1757 |
protected $current_dynamic_sidebar_id_stack = array(); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1758 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1759 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1760 |
* Begins keeping track of the current sidebar being rendered. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1761 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1762 |
* Insert marker before widgets are rendered in a dynamic sidebar. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1763 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1764 |
* @since 4.5.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1765 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1766 |
* @param int|string $index Index, name, or ID of the dynamic sidebar. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1767 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1768 |
public function start_dynamic_sidebar( $index ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1769 |
array_unshift( $this->current_dynamic_sidebar_id_stack, $index ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1770 |
if ( ! isset( $this->sidebar_instance_count[ $index ] ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1771 |
$this->sidebar_instance_count[ $index ] = 0; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1772 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1773 |
$this->sidebar_instance_count[ $index ] += 1; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1774 |
if ( ! $this->manager->selective_refresh->is_render_partials_request() ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1775 |
printf( "\n<!--dynamic_sidebar_before:%s:%d-->\n", esc_html( $index ), intval( $this->sidebar_instance_count[ $index ] ) ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1776 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1777 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1778 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1779 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1780 |
* Finishes keeping track of the current sidebar being rendered. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1781 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1782 |
* Inserts a marker after widgets are rendered in a dynamic sidebar. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1783 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1784 |
* @since 4.5.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1785 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1786 |
* @param int|string $index Index, name, or ID of the dynamic sidebar. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1787 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1788 |
public function end_dynamic_sidebar( $index ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1789 |
array_shift( $this->current_dynamic_sidebar_id_stack ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1790 |
if ( ! $this->manager->selective_refresh->is_render_partials_request() ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1791 |
printf( "\n<!--dynamic_sidebar_after:%s:%d-->\n", esc_html( $index ), intval( $this->sidebar_instance_count[ $index ] ) ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1792 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1793 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1794 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1795 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1796 |
* Current sidebar being rendered. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1797 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1798 |
* @since 4.5.0 |
| 16 | 1799 |
* @var string|null |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1800 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1801 |
protected $rendering_widget_id; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1802 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1803 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1804 |
* Current widget being rendered. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1805 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1806 |
* @since 4.5.0 |
| 16 | 1807 |
* @var string|null |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1808 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1809 |
protected $rendering_sidebar_id; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1810 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1811 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1812 |
* Filters sidebars_widgets to ensure the currently-rendered widget is the only widget in the current sidebar. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1813 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1814 |
* @since 4.5.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1815 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1816 |
* @param array $sidebars_widgets Sidebars widgets. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1817 |
* @return array Filtered sidebars widgets. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1818 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1819 |
public function filter_sidebars_widgets_for_rendering_widget( $sidebars_widgets ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1820 |
$sidebars_widgets[ $this->rendering_sidebar_id ] = array( $this->rendering_widget_id ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1821 |
return $sidebars_widgets; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1822 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1823 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1824 |
/** |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1825 |
* Renders a specific widget using the supplied sidebar arguments. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1826 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1827 |
* @since 4.5.0 |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1828 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1829 |
* @see dynamic_sidebar() |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1830 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1831 |
* @param WP_Customize_Partial $partial Partial. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1832 |
* @param array $context { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1833 |
* Sidebar args supplied as container context. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1834 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1835 |
* @type string $sidebar_id ID for sidebar for widget to render into. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1836 |
* @type int $sidebar_instance_number Disambiguating instance number. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1837 |
* } |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1838 |
* @return string|false |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1839 |
*/ |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1840 |
public function render_widget_partial( $partial, $context ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1841 |
$id_data = $partial->id_data(); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1842 |
$widget_id = array_shift( $id_data['keys'] ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1843 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1844 |
if ( ! is_array( $context ) |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1845 |
|| empty( $context['sidebar_id'] ) |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1846 |
|| ! is_registered_sidebar( $context['sidebar_id'] ) |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1847 |
) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1848 |
return false; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1849 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1850 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1851 |
$this->rendering_sidebar_id = $context['sidebar_id']; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1852 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1853 |
if ( isset( $context['sidebar_instance_number'] ) ) { |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1854 |
$this->context_sidebar_instance_number = intval( $context['sidebar_instance_number'] ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1855 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1856 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1857 |
// Filter sidebars_widgets so that only the queried widget is in the sidebar. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1858 |
$this->rendering_widget_id = $widget_id; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1859 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1860 |
$filter_callback = array( $this, 'filter_sidebars_widgets_for_rendering_widget' ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1861 |
add_filter( 'sidebars_widgets', $filter_callback, 1000 ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1862 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1863 |
// Render the widget. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1864 |
ob_start(); |
| 16 | 1865 |
$this->rendering_sidebar_id = $context['sidebar_id']; |
1866 |
dynamic_sidebar( $this->rendering_sidebar_id ); |
|
1867 |
$container = ob_get_clean(); |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1868 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1869 |
// Reset variables for next partial render. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1870 |
remove_filter( 'sidebars_widgets', $filter_callback, 1000 ); |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1871 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1872 |
$this->context_sidebar_instance_number = null; |
| 9 | 1873 |
$this->rendering_sidebar_id = null; |
1874 |
$this->rendering_widget_id = null; |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1875 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1876 |
return $container; |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1877 |
} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1878 |
|
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1879 |
// |
| 16 | 1880 |
// Option Update Capturing. |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1881 |
// |
| 5 | 1882 |
|
1883 |
/** |
|
1884 |
* List of captured widget option updates. |
|
1885 |
* |
|
1886 |
* @since 3.9.0 |
|
1887 |
* @var array $_captured_options Values updated while option capture is happening. |
|
1888 |
*/ |
|
1889 |
protected $_captured_options = array(); |
|
1890 |
||
1891 |
/** |
|
1892 |
* Whether option capture is currently happening. |
|
1893 |
* |
|
1894 |
* @since 3.9.0 |
|
1895 |
* @var bool $_is_current Whether option capture is currently happening or not. |
|
1896 |
*/ |
|
1897 |
protected $_is_capturing_option_updates = false; |
|
1898 |
||
1899 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1900 |
* Determines whether the captured option update should be ignored. |
| 5 | 1901 |
* |
1902 |
* @since 3.9.0 |
|
1903 |
* |
|
1904 |
* @param string $option_name Option name. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1905 |
* @return bool Whether the option capture is ignored. |
| 5 | 1906 |
*/ |
1907 |
protected function is_option_capture_ignored( $option_name ) { |
|
1908 |
return ( 0 === strpos( $option_name, '_transient_' ) ); |
|
1909 |
} |
|
1910 |
||
1911 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1912 |
* Retrieves captured widget option updates. |
| 5 | 1913 |
* |
1914 |
* @since 3.9.0 |
|
1915 |
* |
|
1916 |
* @return array Array of captured options. |
|
1917 |
*/ |
|
1918 |
protected function get_captured_options() { |
|
1919 |
return $this->_captured_options; |
|
1920 |
} |
|
1921 |
||
1922 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1923 |
* Retrieves the option that was captured from being saved. |
| 5 | 1924 |
* |
1925 |
* @since 4.2.0 |
|
1926 |
* |
|
1927 |
* @param string $option_name Option name. |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1928 |
* @param mixed $default Optional. Default value to return if the option does not exist. Default false. |
| 5 | 1929 |
* @return mixed Value set for the option. |
1930 |
*/ |
|
1931 |
protected function get_captured_option( $option_name, $default = false ) { |
|
1932 |
if ( array_key_exists( $option_name, $this->_captured_options ) ) { |
|
1933 |
$value = $this->_captured_options[ $option_name ]; |
|
1934 |
} else { |
|
1935 |
$value = $default; |
|
1936 |
} |
|
1937 |
return $value; |
|
1938 |
} |
|
1939 |
||
1940 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1941 |
* Retrieves the number of captured widget option updates. |
| 5 | 1942 |
* |
1943 |
* @since 3.9.0 |
|
1944 |
* |
|
1945 |
* @return int Number of updated options. |
|
1946 |
*/ |
|
1947 |
protected function count_captured_options() { |
|
1948 |
return count( $this->_captured_options ); |
|
1949 |
} |
|
1950 |
||
1951 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1952 |
* Begins keeping track of changes to widget options, caching new values. |
| 5 | 1953 |
* |
1954 |
* @since 3.9.0 |
|
1955 |
*/ |
|
1956 |
protected function start_capturing_option_updates() { |
|
1957 |
if ( $this->_is_capturing_option_updates ) { |
|
1958 |
return; |
|
1959 |
} |
|
1960 |
||
1961 |
$this->_is_capturing_option_updates = true; |
|
1962 |
||
1963 |
add_filter( 'pre_update_option', array( $this, 'capture_filter_pre_update_option' ), 10, 3 ); |
|
1964 |
} |
|
1965 |
||
1966 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1967 |
* Pre-filters captured option values before updating. |
| 5 | 1968 |
* |
1969 |
* @since 3.9.0 |
|
1970 |
* |
|
1971 |
* @param mixed $new_value The new option value. |
|
1972 |
* @param string $option_name Name of the option. |
|
1973 |
* @param mixed $old_value The old option value. |
|
1974 |
* @return mixed Filtered option value. |
|
1975 |
*/ |
|
1976 |
public function capture_filter_pre_update_option( $new_value, $option_name, $old_value ) { |
|
1977 |
if ( $this->is_option_capture_ignored( $option_name ) ) { |
|
| 16 | 1978 |
return $new_value; |
| 5 | 1979 |
} |
1980 |
||
1981 |
if ( ! isset( $this->_captured_options[ $option_name ] ) ) { |
|
1982 |
add_filter( "pre_option_{$option_name}", array( $this, 'capture_filter_pre_get_option' ) ); |
|
1983 |
} |
|
1984 |
||
1985 |
$this->_captured_options[ $option_name ] = $new_value; |
|
1986 |
||
1987 |
return $old_value; |
|
1988 |
} |
|
1989 |
||
1990 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
1991 |
* Pre-filters captured option values before retrieving. |
| 5 | 1992 |
* |
1993 |
* @since 3.9.0 |
|
1994 |
* |
|
1995 |
* @param mixed $value Value to return instead of the option value. |
|
1996 |
* @return mixed Filtered option value. |
|
1997 |
*/ |
|
1998 |
public function capture_filter_pre_get_option( $value ) { |
|
1999 |
$option_name = preg_replace( '/^pre_option_/', '', current_filter() ); |
|
2000 |
||
2001 |
if ( isset( $this->_captured_options[ $option_name ] ) ) { |
|
2002 |
$value = $this->_captured_options[ $option_name ]; |
|
2003 |
||
2004 |
/** This filter is documented in wp-includes/option.php */ |
|
| 9 | 2005 |
$value = apply_filters( 'option_' . $option_name, $value, $option_name ); |
| 5 | 2006 |
} |
2007 |
||
2008 |
return $value; |
|
2009 |
} |
|
2010 |
||
2011 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2012 |
* Undoes any changes to the options since options capture began. |
| 5 | 2013 |
* |
2014 |
* @since 3.9.0 |
|
2015 |
*/ |
|
2016 |
protected function stop_capturing_option_updates() { |
|
2017 |
if ( ! $this->_is_capturing_option_updates ) { |
|
2018 |
return; |
|
2019 |
} |
|
2020 |
||
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2021 |
remove_filter( 'pre_update_option', array( $this, 'capture_filter_pre_update_option' ), 10 ); |
| 5 | 2022 |
|
2023 |
foreach ( array_keys( $this->_captured_options ) as $option_name ) { |
|
2024 |
remove_filter( "pre_option_{$option_name}", array( $this, 'capture_filter_pre_get_option' ) ); |
|
2025 |
} |
|
2026 |
||
| 9 | 2027 |
$this->_captured_options = array(); |
| 5 | 2028 |
$this->_is_capturing_option_updates = false; |
2029 |
} |
|
2030 |
||
2031 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2032 |
* {@internal Missing Summary} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2033 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2034 |
* See the {@see 'customize_dynamic_setting_args'} filter. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2035 |
* |
| 5 | 2036 |
* @since 3.9.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2037 |
* @deprecated 4.2.0 Deprecated in favor of the {@see 'customize_dynamic_setting_args'} filter. |
| 5 | 2038 |
*/ |
2039 |
public function setup_widget_addition_previews() { |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2040 |
_deprecated_function( __METHOD__, '4.2.0', 'customize_dynamic_setting_args' ); |
| 5 | 2041 |
} |
2042 |
||
2043 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2044 |
* {@internal Missing Summary} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2045 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2046 |
* See the {@see 'customize_dynamic_setting_args'} filter. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2047 |
* |
| 5 | 2048 |
* @since 3.9.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2049 |
* @deprecated 4.2.0 Deprecated in favor of the {@see 'customize_dynamic_setting_args'} filter. |
| 5 | 2050 |
*/ |
2051 |
public function prepreview_added_sidebars_widgets() { |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2052 |
_deprecated_function( __METHOD__, '4.2.0', 'customize_dynamic_setting_args' ); |
| 5 | 2053 |
} |
2054 |
||
2055 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2056 |
* {@internal Missing Summary} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2057 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2058 |
* See the {@see 'customize_dynamic_setting_args'} filter. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2059 |
* |
| 5 | 2060 |
* @since 3.9.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2061 |
* @deprecated 4.2.0 Deprecated in favor of the {@see 'customize_dynamic_setting_args'} filter. |
| 5 | 2062 |
*/ |
2063 |
public function prepreview_added_widget_instance() { |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2064 |
_deprecated_function( __METHOD__, '4.2.0', 'customize_dynamic_setting_args' ); |
| 5 | 2065 |
} |
2066 |
||
2067 |
/** |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2068 |
* {@internal Missing Summary} |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2069 |
* |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2070 |
* See the {@see 'customize_dynamic_setting_args'} filter. |
|
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2071 |
* |
| 5 | 2072 |
* @since 3.9.0 |
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2073 |
* @deprecated 4.2.0 Deprecated in favor of the {@see 'customize_dynamic_setting_args'} filter. |
| 5 | 2074 |
*/ |
2075 |
public function remove_prepreview_filters() { |
|
|
7
cf61fcea0001
resynchronize code repo with production
ymh <ymh.work@gmail.com>
parents:
5
diff
changeset
|
2076 |
_deprecated_function( __METHOD__, '4.2.0', 'customize_dynamic_setting_args' ); |
| 5 | 2077 |
} |
2078 |
} |