← Back to branch summary

~canonical-sysadmins/wordpress/4.8.3

« back to all changes in this revision

Viewing changes to wp-includes/class-wp-customize-widgets.php

  • Committer: Ryan Finnie
  • Date: 2015-08-31 16:09:47 UTC
  • mfrom: (1.1.9 upstream)
  • Revision ID: ryan.finnie@canonical.com-20150831160947-1h6rfxby9z1ec62u
Merge WP4.3 from upstream

Show diffs side-by-side

added added

removed removed

Lines of Context:
wp-includes/class-wp-customize-widgets.php
108
108
         * @since 4.2.0
109
109
         * @access protected
110
110
         *
 
111
         * @staticvar array $cache
 
112
         *
111
113
         * @param $setting_id Setting ID.
112
 
         * @return string|null Setting type. Null otherwise.
 
114
         * @return string|void Setting type.
113
115
         */
114
116
        protected function get_setting_type( $setting_id ) {
115
117
                static $cache = array();
122
124
                                return $type;
123
125
                        }
124
126
                }
125
 
                return null;
126
127
        }
127
128
 
128
129
        /**
204
205
         *
205
206
         * @since 3.9.0
206
207
         * @access public
 
208
         *
 
209
         * @global array $sidebars_widgets
 
210
         * @global array $_wp_sidebars_widgets
207
211
         */
208
212
        public function override_sidebars_widgets_for_theme_switch() {
209
213
                global $sidebars_widgets;
219
223
                $sidebars_widgets = $this->old_sidebars_widgets;
220
224
                $sidebars_widgets = retrieve_widgets( 'customize' );
221
225
                add_filter( 'option_sidebars_widgets', array( $this, 'filter_option_sidebars_widgets_for_theme_switch' ), 1 );
222
 
                unset( $GLOBALS['_wp_sidebars_widgets'] ); // reset global cache var used by wp_get_sidebars_widgets()
 
226
                // reset global cache var used by wp_get_sidebars_widgets()
 
227
                unset( $GLOBALS['_wp_sidebars_widgets'] );
223
228
        }
224
229
 
225
230
        /**
236
241
         * @access public
237
242
         *
238
243
         * @param array $old_sidebars_widgets
 
244
         * @return array
239
245
         */
240
246
        public function filter_customize_value_old_sidebars_widgets_data( $old_sidebars_widgets ) {
241
247
                return $this->old_sidebars_widgets;
252
258
         * @since 3.9.0
253
259
         * @access public
254
260
         *
 
261
         * @global array $sidebars_widgets
 
262
         *
255
263
         * @param array $sidebars_widgets
 
264
         * @return array
256
265
         */
257
266
        public function filter_option_sidebars_widgets_for_theme_switch( $sidebars_widgets ) {
258
267
                $sidebars_widgets = $GLOBALS['sidebars_widgets'];
302
311
         *
303
312
         * @since 3.9.0
304
313
         * @access public
 
314
         *
 
315
         * @global array $wp_registered_widgets
 
316
         * @global array $wp_registered_widget_controls
 
317
         * @global array $wp_registered_sidebars
305
318
         */
306
319
        public function customize_register() {
307
320
                global $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_sidebars;
308
321
 
309
322
                $sidebars_widgets = array_merge(
310
323
                        array( 'wp_inactive_widgets' => array() ),
311
 
                        array_fill_keys( array_keys( $GLOBALS['wp_registered_sidebars'] ), array() ),
 
324
                        array_fill_keys( array_keys( $wp_registered_sidebars ), array() ),
312
325
                        wp_get_sidebars_widgets()
313
326
                );
314
327
 
352
365
                                $sidebar_widget_ids = array();
353
366
                        }
354
367
 
355
 
                        $is_registered_sidebar = isset( $GLOBALS['wp_registered_sidebars'][$sidebar_id] );
 
368
                        $is_registered_sidebar = isset( $wp_registered_sidebars[ $sidebar_id ] );
356
369
                        $is_inactive_widgets   = ( 'wp_inactive_widgets' === $sidebar_id );
357
370
                        $is_active_sidebar     = ( $is_registered_sidebar && ! $is_inactive_widgets );
358
371
 
373
386
                                if ( $is_active_sidebar ) {
374
387
 
375
388
                                        $section_args = array(
376
 
                                                'title' => $GLOBALS['wp_registered_sidebars'][ $sidebar_id ]['name'],
377
 
                                                'description' => $GLOBALS['wp_registered_sidebars'][ $sidebar_id ]['description'],
 
389
                                                'title' => $wp_registered_sidebars[ $sidebar_id ]['name'],
 
390
                                                'description' => $wp_registered_sidebars[ $sidebar_id ]['description'],
378
391
                                                'priority' => array_search( $sidebar_id, array_keys( $wp_registered_sidebars ) ),
379
392
                                                'panel' => 'widgets',
380
393
                                                'sidebar_id' => $sidebar_id,
409
422
                        foreach ( $sidebar_widget_ids as $i => $widget_id ) {
410
423
 
411
424
                                // Skip widgets that may have gone away due to a plugin being deactivated.
412
 
                                if ( ! $is_active_sidebar || ! isset( $GLOBALS['wp_registered_widgets'][$widget_id] ) ) {
 
425
                                if ( ! $is_active_sidebar || ! isset( $wp_registered_widgets[$widget_id] ) ) {
413
426
                                        continue;
414
427
                                }
415
428
 
416
 
                                $registered_widget = $GLOBALS['wp_registered_widgets'][$widget_id];
 
429
                                $registered_widget = $wp_registered_widgets[$widget_id];
417
430
                                $setting_id        = $this->get_setting_id( $widget_id );
418
 
                                $id_base           = $GLOBALS['wp_registered_widget_controls'][$widget_id]['id_base'];
 
431
                                $id_base           = $wp_registered_widget_controls[$widget_id]['id_base'];
419
432
 
420
433
                                $control = new WP_Widget_Form_Customize_Control( $this->manager, $setting_id, array(
421
434
                                        'label'          => $registered_widget['name'],
473
486
         * @since 3.9.0
474
487
         * @access public
475
488
         *
 
489
         * @global $wp_registered_widget_controls
 
490
         *
476
491
         * @param string $widget_id Widget ID.
477
492
         * @return bool Whether or not the widget is a "wide" widget.
478
493
         */
576
591
         *
577
592
         * @since 3.9.0
578
593
         * @access public
 
594
         *
 
595
         * @global WP_Scripts $wp_scripts
 
596
         * @global array $wp_registered_sidebars
 
597
         * @global array $wp_registered_widgets
579
598
         */
580
599
        public function enqueue_scripts() {
 
600
                global $wp_scripts, $wp_registered_sidebars, $wp_registered_widgets;
 
601
 
581
602
                wp_enqueue_style( 'customize-widgets' );
582
603
                wp_enqueue_script( 'customize-widgets' );
583
604
 
621
642
                        </div>'
622
643
                );
623
644
 
624
 
                global $wp_scripts;
625
 
 
626
645
                $settings = array(
627
646
                        'nonce'                => wp_create_nonce( 'update-widget' ),
628
 
                        'registeredSidebars'   => array_values( $GLOBALS['wp_registered_sidebars'] ),
629
 
                        'registeredWidgets'    => $GLOBALS['wp_registered_widgets'],
 
647
                        'registeredSidebars'   => array_values( $wp_registered_sidebars ),
 
648
                        'registeredWidgets'    => $wp_registered_widgets,
630
649
                        'availableWidgets'     => $available_widgets, // @todo Merge this with registered_widgets
631
650
                        'l10n' => array(
632
651
                                'saveBtnLabel'     => __( 'Apply' ),
664
683
                ?>
665
684
                <div id="widgets-left"><!-- compatibility with JS which looks for widget templates here -->
666
685
                <div id="available-widgets">
 
686
                        <div class="customize-section-title">
 
687
                                <button class="customize-section-back" tabindex="-1">
 
688
                                        <span class="screen-reader-text"><?php _e( 'Back' ); ?></span>
 
689
                                </button>
 
690
                                <h3>
 
691
                                        <span class="customize-action"><?php
 
692
                                                /* translators: &#9656; is the unicode right-pointing triangle, and %s is the section title in the Customizer */
 
693
                                                echo sprintf( __( 'Customizing &#9656; %s' ), esc_html( $this->manager->get_panel( 'widgets' )->title ) );
 
694
                                        ?></span>
 
695
                                        <?php _e( 'Add a Widget' ); ?>
 
696
                                </h3>
 
697
                        </div>
667
698
                        <div id="available-widgets-filter">
668
699
                                <label class="screen-reader-text" for="widgets-search"><?php _e( 'Search Widgets' ); ?></label>
669
700
                                <input type="search" id="widgets-search" placeholder="<?php esc_attr_e( 'Search widgets&hellip;' ) ?>" />
716
747
                if ( preg_match( $this->setting_id_patterns['sidebar_widgets'], $id, $matches ) ) {
717
748
                        $args['sanitize_callback'] = array( $this, 'sanitize_sidebar_widgets' );
718
749
                        $args['sanitize_js_callback'] = array( $this, 'sanitize_sidebar_widgets_js_instance' );
719
 
                } else if ( preg_match( $this->setting_id_patterns['widget_instance'], $id, $matches ) ) {
 
750
                } elseif ( preg_match( $this->setting_id_patterns['widget_instance'], $id, $matches ) ) {
720
751
                        $args['sanitize_callback'] = array( $this, 'sanitize_widget_instance' );
721
752
                        $args['sanitize_js_callback'] = array( $this, 'sanitize_widget_js_instance' );
722
753
                }
762
793
         * @since 3.9.0
763
794
         * @access public
764
795
         *
 
796
         * @global array $wp_registered_widgets
 
797
         * @global array $wp_registered_widget_controls
 
798
         * @staticvar array $available_widgets
 
799
         *
765
800
         * @see wp_list_widgets()
766
801
         *
767
802
         * @return array List of available widgets.
843
878
         * Naturally order available widgets by name.
844
879
         *
845
880
         * @since 3.9.0
846
 
         * @static
847
881
         * @access protected
848
882
         *
849
883
         * @param array $widget_a The first widget to compare.
918
952
         * @access public
919
953
         *
920
954
         * @param array $sidebars_widgets List of widgets for the current sidebar.
 
955
         * @return array
921
956
         */
922
957
        public function preview_sidebars_widgets( $sidebars_widgets ) {
923
958
                $sidebars_widgets = get_option( 'sidebars_widgets' );
965
1000
         *
966
1001
         * @since 3.9.0
967
1002
         * @access public
 
1003
     *
 
1004
         * @global array $wp_registered_sidebars
 
1005
         * @global array $wp_registered_widgets
968
1006
         */
969
1007
        public function export_preview_data() {
970
 
 
 
1008
                global $wp_registered_sidebars, $wp_registered_widgets;
971
1009
                // Prepare Customizer settings to pass to JavaScript.
972
1010
                $settings = array(
973
1011
                        'renderedSidebars'   => array_fill_keys( array_unique( $this->rendered_sidebars ), true ),
974
1012
                        'renderedWidgets'    => array_fill_keys( array_keys( $this->rendered_widgets ), true ),
975
 
                        'registeredSidebars' => array_values( $GLOBALS['wp_registered_sidebars'] ),
976
 
                        'registeredWidgets'  => $GLOBALS['wp_registered_widgets'],
 
1013
                        'registeredSidebars' => array_values( $wp_registered_sidebars ),
 
1014
                        'registeredWidgets'  => $wp_registered_widgets,
977
1015
                        'l10n'               => array(
978
1016
                                'widgetTooltip' => __( 'Shift-click to edit this widget.' ),
979
1017
                        ),
1038
1076
         * @since 3.9.0
1039
1077
         * @access public
1040
1078
         *
 
1079
         * @global array $wp_registered_sidebars
 
1080
         *
1041
1081
         * @param bool   $is_active  Whether the sidebar is active.
1042
1082
         * @param string $sidebar_id Sidebar ID.
 
1083
         * @return bool
1043
1084
         */
1044
1085
        public function tally_sidebars_via_is_active_sidebar_calls( $is_active, $sidebar_id ) {
1045
1086
                if ( isset( $GLOBALS['wp_registered_sidebars'][$sidebar_id] ) ) {
1063
1104
         * @since 3.9.0
1064
1105
         * @access public
1065
1106
         *
 
1107
         * @global array $wp_registered_sidebars
 
1108
         *
1066
1109
         * @param bool   $has_widgets Whether the current sidebar has widgets.
1067
1110
         * @param string $sidebar_id  Sidebar ID.
 
1111
         * @return bool
1068
1112
         */
1069
1113
        public function tally_sidebars_via_dynamic_sidebar_calls( $has_widgets, $sidebar_id ) {
1070
1114
                if ( isset( $GLOBALS['wp_registered_sidebars'][$sidebar_id] ) ) {
1105
1149
         * @access public
1106
1150
         *
1107
1151
         * @param array $value Widget instance to sanitize.
1108
 
         * @return array Sanitized widget instance.
 
1152
         * @return array|void Sanitized widget instance.
1109
1153
         */
1110
1154
        public function sanitize_widget_instance( $value ) {
1111
1155
                if ( $value === array() ) {
1116
1160
                        || empty( $value['instance_hash_key'] )
1117
1161
                        || empty( $value['encoded_serialized_instance'] ) )
1118
1162
                {
1119
 
                        return null;
 
1163
                        return;
1120
1164
                }
1121
1165
 
1122
1166
                $decoded = base64_decode( $value['encoded_serialized_instance'], true );
1123
1167
                if ( false === $decoded ) {
1124
 
                        return null;
 
1168
                        return;
1125
1169
                }
1126
1170
 
1127
1171
                if ( ! hash_equals( $this->get_instance_hash_key( $decoded ), $value['instance_hash_key'] ) ) {
1128
 
                        return null;
 
1172
                        return;
1129
1173
                }
1130
1174
 
1131
1175
                $instance = unserialize( $decoded );
1132
1176
                if ( false === $instance ) {
1133
 
                        return null;
 
1177
                        return;
1134
1178
                }
1135
1179
 
1136
1180
                return $instance;
1168
1212
         * @since 3.9.0
1169
1213
         * @access public
1170
1214
         *
 
1215
         * @global array $wp_registered_widgets
 
1216
         *
1171
1217
         * @param array $widget_ids List of widget IDs.
1172
1218
         * @return array Parsed list of widget IDs.
1173
1219
         */
1185
1231
         * @since 3.9.0
1186
1232
         * @access public
1187
1233
         *
 
1234
         * @global array $wp_registered_widget_updates
 
1235
         * @global array $wp_registered_widget_controls
 
1236
         *
1188
1237
         * @param  string $widget_id Widget ID.
1189
1238
         * @return WP_Error|array Array containing the updated widget information.
1190
1239
         *                        A WP_Error object, otherwise.
1192
1241
        public function call_widget_update( $widget_id ) {
1193
1242
                global $wp_registered_widget_updates, $wp_registered_widget_controls;
1194
1243
 
 
1244
                $setting_id = $this->get_setting_id( $widget_id );
 
1245
 
 
1246
                /*
 
1247
                 * Make sure that other setting changes have previewed since this widget
 
1248
                 * may depend on them (e.g. Menus being present for Custom Menu widget).
 
1249
                 */
 
1250
                if ( ! did_action( 'customize_preview_init' ) ) {
 
1251
                        foreach ( $this->manager->settings() as $setting ) {
 
1252
                                if ( $setting->id !== $setting_id ) {
 
1253
                                        $setting->preview();
 
1254
                                }
 
1255
                        }
 
1256
                }
 
1257
 
1195
1258
                $this->start_capturing_option_updates();
1196
1259
                $parsed_id   = $this->parse_widget_id( $widget_id );
1197
1260
                $option_name = 'widget_' . $parsed_id['id_base'];
1272
1335
                 * in place from WP_Customize_Setting::preview() will use this value
1273
1336
                 * instead of the default widget instance value (an empty array).
1274
1337
                 */
1275
 
                $setting_id = $this->get_setting_id( $widget_id );
1276
1338
                $this->manager->set_post_value( $setting_id, $instance );
1277
1339
 
1278
1340
                // Obtain the widget control with the updated instance in place.
1344
1406
 
1345
1407
                $updated_widget = $this->call_widget_update( $widget_id ); // => {instance,form}
1346
1408
                if ( is_wp_error( $updated_widget ) ) {
1347
 
                        wp_send_json_error( $updated_widget->get_error_message() );
 
1409
                        wp_send_json_error( $updated_widget->get_error_code() );
1348
1410
                }
1349
1411
 
1350
1412
                $form = $updated_widget['form'];
1382
1444
         * @access protected
1383
1445
         *
1384
1446
         * @param string $option_name Option name.
1385
 
         * @return boolean Whether the option capture is ignored.
 
1447
         * @return bool Whether the option capture is ignored.
1386
1448
         */
1387
1449
        protected function is_option_capture_ignored( $option_name ) {
1388
1450
                return ( 0 === strpos( $option_name, '_transient_' ) );