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