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