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