| [ 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 %>" tabindex="0"> 737 <div><strong><%- sidebar.name %></strong></div> 738 <div><%- sidebar.description %></div> 739 </li> 740 <% }); %> 741 </ul> 742 <div class="move-widget-actions"> 743 <button class="move-widget-btn button" type="button">{btn}</button> 744 </div> 745 </div>' 746 ); 747 748 /* 749 * Gather all strings in PHP that may be needed by JS on the client. 750 * Once JS i18n is implemented (in #20491), this can be removed. 751 */ 752 $some_non_rendered_areas_messages = array(); 753 $some_non_rendered_areas_messages[1] = html_entity_decode( 754 __( 'Your theme has 1 other widget area, but this particular page does not display it.' ), 755 ENT_QUOTES, 756 get_bloginfo( 'charset' ) 757 ); 758 $registered_sidebar_count = count( $wp_registered_sidebars ); 759 for ( $non_rendered_count = 2; $non_rendered_count < $registered_sidebar_count; $non_rendered_count++ ) { 760 $some_non_rendered_areas_messages[ $non_rendered_count ] = html_entity_decode( 761 sprintf( 762 /* translators: %s: The number of other widget areas registered but not rendered. */ 763 _n( 764 'Your theme has %s other widget area, but this particular page does not display it.', 765 'Your theme has %s other widget areas, but this particular page does not display them.', 766 $non_rendered_count 767 ), 768 number_format_i18n( $non_rendered_count ) 769 ), 770 ENT_QUOTES, 771 get_bloginfo( 'charset' ) 772 ); 773 } 774 775 if ( 1 === $registered_sidebar_count ) { 776 $no_areas_shown_message = html_entity_decode( 777 sprintf( 778 __( 'Your theme has 1 widget area, but this particular page does not display it.' ) 779 ), 780 ENT_QUOTES, 781 get_bloginfo( 'charset' ) 782 ); 783 } else { 784 $no_areas_shown_message = html_entity_decode( 785 sprintf( 786 /* translators: %s: The total number of widget areas registered. */ 787 _n( 788 'Your theme has %s widget area, but this particular page does not display it.', 789 'Your theme has %s widget areas, but this particular page does not display them.', 790 $registered_sidebar_count 791 ), 792 number_format_i18n( $registered_sidebar_count ) 793 ), 794 ENT_QUOTES, 795 get_bloginfo( 'charset' ) 796 ); 797 } 798 799 $settings = array( 800 'registeredSidebars' => array_values( $wp_registered_sidebars ), 801 'registeredWidgets' => $wp_registered_widgets, 802 'availableWidgets' => $available_widgets, // @todo Merge this with registered_widgets. 803 'l10n' => array( 804 'saveBtnLabel' => __( 'Apply' ), 805 'saveBtnTooltip' => __( 'Save and preview changes before publishing them.' ), 806 'removeBtnLabel' => __( 'Remove' ), 807 'removeBtnTooltip' => __( 'Keep widget settings and move it to the inactive widgets' ), 808 'error' => __( 'An error has occurred. Please reload the page and try again.' ), 809 'widgetMovedUp' => __( 'Widget moved up' ), 810 'widgetMovedDown' => __( 'Widget moved down' ), 811 'navigatePreview' => __( 'You can navigate to other pages on your site while using the Customizer to view and edit the widgets displayed on those pages.' ), 812 'someAreasShown' => $some_non_rendered_areas_messages, 813 'noAreasShown' => $no_areas_shown_message, 814 'reorderModeOn' => __( 'Reorder mode enabled' ), 815 'reorderModeOff' => __( 'Reorder mode closed' ), 816 'reorderLabelOn' => esc_attr__( 'Reorder widgets' ), 817 /* translators: %d: The number of widgets found. */ 818 'widgetsFound' => __( 'Number of widgets found: %d' ), 819 'noWidgetsFound' => __( 'No widgets found.' ), 820 ), 821 'tpl' => array( 822 'widgetReorderNav' => $widget_reorder_nav_tpl, 823 'moveWidgetArea' => $move_widget_area_tpl, 824 ), 825 'selectiveRefreshableWidgets' => $this->get_selective_refreshable_widgets(), 826 ); 827 828 foreach ( $settings['registeredWidgets'] as &$registered_widget ) { 829 unset( $registered_widget['callback'] ); // May not be JSON-serializable. 830 } 831 832 $wp_scripts->add_data( 833 'customize-widgets', 834 'data', 835 sprintf( 'var _wpCustomizeWidgetsSettings = %s;', wp_json_encode( $settings ) ) 836 ); 837 838 /* 839 * TODO: Update 'wp-customize-widgets' to not rely so much on things in 840 * 'customize-widgets'. This will let us skip most of the above and not 841 * enqueue 'customize-widgets' which saves bytes. 842 */ 843 844 if ( wp_use_widgets_block_editor() ) { 845 $block_editor_context = new WP_Block_Editor_Context( 846 array( 847 'name' => 'core/customize-widgets', 848 ) 849 ); 850 851 $editor_settings = get_block_editor_settings( 852 get_legacy_widget_block_editor_settings(), 853 $block_editor_context 854 ); 855 856 wp_add_inline_script( 857 'wp-customize-widgets', 858 sprintf( 859 'wp.domReady( function() { 860 wp.customizeWidgets.initialize( "widgets-customizer", %s ); 861 } );', 862 wp_json_encode( $editor_settings ) 863 ) 864 ); 865 866 // Preload server-registered block schemas. 867 wp_add_inline_script( 868 'wp-blocks', 869 'wp.blocks.unstable__bootstrapServerSideBlockDefinitions(' . wp_json_encode( get_block_editor_server_block_settings() ) . ');' 870 ); 871 872 // Preload server-registered block bindings sources. 873 $registered_sources = get_all_registered_block_bindings_sources(); 874 if ( ! empty( $registered_sources ) ) { 875 $filtered_sources = array(); 876 foreach ( $registered_sources as $source ) { 877 $filtered_sources[] = array( 878 'name' => $source->name, 879 'label' => $source->label, 880 'usesContext' => $source->uses_context, 881 ); 882 } 883 $script = sprintf( 'for ( const source of %s ) { wp.blocks.registerBlockBindingsSource( source ); }', wp_json_encode( $filtered_sources ) ); 884 wp_add_inline_script( 885 'wp-blocks', 886 $script 887 ); 888 } 889 890 wp_add_inline_script( 891 'wp-blocks', 892 sprintf( 'wp.blocks.setCategories( %s );', wp_json_encode( get_block_categories( $block_editor_context ) ) ), 893 'after' 894 ); 895 896 wp_enqueue_script( 'wp-customize-widgets' ); 897 wp_enqueue_style( 'wp-customize-widgets' ); 898 899 /** This action is documented in edit-form-blocks.php */ 900 do_action( 'enqueue_block_editor_assets' ); 901 } 902 } 903 904 /** 905 * Renders the widget form control templates into the DOM. 906 * 907 * @since 3.9.0 908 */ 909 public function output_widget_control_templates() { 910 ?> 911 <div id="widgets-left"><!-- compatibility with JS which looks for widget templates here --> 912 <div id="available-widgets"> 913 <div class="customize-section-title"> 914 <button class="customize-section-back" tabindex="-1"> 915 <span class="screen-reader-text"> 916 <?php 917 /* translators: Hidden accessibility text. */ 918 _e( 'Back' ); 919 ?> 920 </span> 921 </button> 922 <h3> 923 <span class="customize-action"> 924 <?php 925 $panel = $this->manager->get_panel( 'widgets' ); 926 $panel_title = isset( $panel->title ) ? $panel->title : __( 'Widgets' ); 927 /* translators: ▸ is the unicode right-pointing triangle. %s: Section title in the Customizer. */ 928 printf( __( 'Customizing ▸ %s' ), esc_html( $panel_title ) ); 929 ?> 930 </span> 931 <?php _e( 'Add a Widget' ); ?> 932 </h3> 933 </div> 934 <div id="available-widgets-filter"> 935 <label for="widgets-search"> 936 <?php 937 /* translators: Hidden accessibility text. */ 938 _e( 'Search Widgets' ); 939 ?> 940 </label> 941 <input type="text" id="widgets-search" aria-describedby="widgets-search-desc" /> 942 <div class="search-icon" aria-hidden="true"></div> 943 <button type="button" class="clear-results"><span class="screen-reader-text"> 944 <?php 945 /* translators: Hidden accessibility text. */ 946 _e( 'Clear Results' ); 947 ?> 948 </span></button> 949 <p class="screen-reader-text" id="widgets-search-desc"> 950 <?php 951 /* translators: Hidden accessibility text. */ 952 _e( 'The search results will be updated as you type.' ); 953 ?> 954 </p> 955 </div> 956 <div id="available-widgets-list"> 957 <?php foreach ( $this->get_available_widgets() as $available_widget ) : ?> 958 <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"> 959 <?php echo $available_widget['control_tpl']; ?> 960 </div> 961 <?php endforeach; ?> 962 <p class="no-widgets-found-message"><?php _e( 'No widgets found.' ); ?></p> 963 </div><!-- #available-widgets-list --> 964 </div><!-- #available-widgets --> 965 </div><!-- #widgets-left --> 966 <?php 967 } 968 969 /** 970 * Calls admin_print_footer_scripts and admin_print_scripts hooks to 971 * allow custom scripts from plugins. 972 * 973 * @since 3.9.0 974 */ 975 public function print_footer_scripts() { 976 /** This action is documented in wp-admin/admin-footer.php */ 977 do_action( 'admin_print_footer_scripts-widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores 978 979 /** This action is documented in wp-admin/admin-footer.php */ 980 do_action( 'admin_print_footer_scripts' ); 981 982 /** This action is documented in wp-admin/admin-footer.php */ 983 do_action( 'admin_footer-widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores 984 } 985 986 /** 987 * Retrieves common arguments to supply when constructing a Customizer setting. 988 * 989 * @since 3.9.0 990 * 991 * @param string $id Widget setting ID. 992 * @param array $overrides Array of setting overrides. 993 * @return array Possibly modified setting arguments. 994 */ 995 public function get_setting_args( $id, $overrides = array() ) { 996 $args = array( 997 'type' => 'option', 998 'capability' => 'edit_theme_options', 999 'default' => array(), 1000 ); 1001 1002 if ( preg_match( $this->setting_id_patterns['sidebar_widgets'], $id, $matches ) ) { 1003 $args['sanitize_callback'] = array( $this, 'sanitize_sidebar_widgets' ); 1004 $args['sanitize_js_callback'] = array( $this, 'sanitize_sidebar_widgets_js_instance' ); 1005 $args['transport'] = current_theme_supports( 'customize-selective-refresh-widgets' ) ? 'postMessage' : 'refresh'; 1006 } elseif ( preg_match( $this->setting_id_patterns['widget_instance'], $id, $matches ) ) { 1007 $id_base = $matches['id_base']; 1008 $args['sanitize_callback'] = function ( $value ) use ( $id_base ) { 1009 return $this->sanitize_widget_instance( $value, $id_base ); 1010 }; 1011 $args['sanitize_js_callback'] = function ( $value ) use ( $id_base ) { 1012 return $this->sanitize_widget_js_instance( $value, $id_base ); 1013 }; 1014 $args['transport'] = $this->is_widget_selective_refreshable( $matches['id_base'] ) ? 'postMessage' : 'refresh'; 1015 } 1016 1017 $args = array_merge( $args, $overrides ); 1018 1019 /** 1020 * Filters the common arguments supplied when constructing a Customizer setting. 1021 * 1022 * @since 3.9.0 1023 * 1024 * @see WP_Customize_Setting 1025 * 1026 * @param array $args Array of Customizer setting arguments. 1027 * @param string $id Widget setting ID. 1028 */ 1029 return apply_filters( 'widget_customizer_setting_args', $args, $id ); 1030 } 1031 1032 /** 1033 * Ensures sidebar widget arrays only ever contain widget IDS. 1034 * 1035 * Used as the 'sanitize_callback' for each $sidebars_widgets setting. 1036 * 1037 * @since 3.9.0 1038 * 1039 * @param string[] $widget_ids Array of widget IDs. 1040 * @return string[] Array of sanitized widget IDs. 1041 */ 1042 public function sanitize_sidebar_widgets( $widget_ids ) { 1043 $widget_ids = array_map( 'strval', (array) $widget_ids ); 1044 $sanitized_widget_ids = array(); 1045 foreach ( $widget_ids as $widget_id ) { 1046 $sanitized_widget_ids[] = preg_replace( '/[^a-z0-9_\-]/', '', $widget_id ); 1047 } 1048 return $sanitized_widget_ids; 1049 } 1050 1051 /** 1052 * Builds up an index of all available widgets for use in Backbone models. 1053 * 1054 * @since 3.9.0 1055 * 1056 * @global array $wp_registered_widgets 1057 * @global array $wp_registered_widget_controls 1058 * 1059 * @see wp_list_widgets() 1060 * 1061 * @return array List of available widgets. 1062 */ 1063 public function get_available_widgets() { 1064 static $available_widgets = array(); 1065 if ( ! empty( $available_widgets ) ) { 1066 return $available_widgets; 1067 } 1068 1069 global $wp_registered_widgets, $wp_registered_widget_controls; 1070 require_once ABSPATH . 'wp-admin/includes/widgets.php'; // For next_widget_id_number(). 1071 1072 $sort = $wp_registered_widgets; 1073 usort( $sort, array( $this, '_sort_name_callback' ) ); 1074 $done = array(); 1075 1076 foreach ( $sort as $widget ) { 1077 if ( in_array( $widget['callback'], $done, true ) ) { // We already showed this multi-widget. 1078 continue; 1079 } 1080 1081 $sidebar = is_active_widget( $widget['callback'], $widget['id'], false, false ); 1082 $done[] = $widget['callback']; 1083 1084 if ( ! isset( $widget['params'][0] ) ) { 1085 $widget['params'][0] = array(); 1086 } 1087 1088 $available_widget = $widget; 1089 unset( $available_widget['callback'] ); // Not serializable to JSON. 1090 1091 $args = array( 1092 'widget_id' => $widget['id'], 1093 'widget_name' => $widget['name'], 1094 '_display' => 'template', 1095 ); 1096 1097 $is_disabled = false; 1098 $is_multi_widget = ( isset( $wp_registered_widget_controls[ $widget['id'] ]['id_base'] ) && isset( $widget['params'][0]['number'] ) ); 1099 if ( $is_multi_widget ) { 1100 $id_base = $wp_registered_widget_controls[ $widget['id'] ]['id_base']; 1101 $args['_temp_id'] = "$id_base-__i__"; 1102 $args['_multi_num'] = next_widget_id_number( $id_base ); 1103 $args['_add'] = 'multi'; 1104 } else { 1105 $args['_add'] = 'single'; 1106 1107 if ( $sidebar && 'wp_inactive_widgets' !== $sidebar ) { 1108 $is_disabled = true; 1109 } 1110 $id_base = $widget['id']; 1111 } 1112 1113 $list_widget_controls_args = wp_list_widget_controls_dynamic_sidebar( 1114 array( 1115 0 => $args, 1116 1 => $widget['params'][0], 1117 ) 1118 ); 1119 $control_tpl = $this->get_widget_control( $list_widget_controls_args ); 1120 1121 // The properties here are mapped to the Backbone Widget model. 1122 $available_widget = array_merge( 1123 $available_widget, 1124 array( 1125 'temp_id' => isset( $args['_temp_id'] ) ? $args['_temp_id'] : null, 1126 'is_multi' => $is_multi_widget, 1127 'control_tpl' => $control_tpl, 1128 'multi_number' => ( 'multi' === $args['_add'] ) ? $args['_multi_num'] : false, 1129 'is_disabled' => $is_disabled, 1130 'id_base' => $id_base, 1131 'transport' => $this->is_widget_selective_refreshable( $id_base ) ? 'postMessage' : 'refresh', 1132 'width' => $wp_registered_widget_controls[ $widget['id'] ]['width'], 1133 'height' => $wp_registered_widget_controls[ $widget['id'] ]['height'], 1134 'is_wide' => $this->is_wide_widget( $widget['id'] ), 1135 ) 1136 ); 1137 1138 $available_widgets[] = $available_widget; 1139 } 1140 1141 return $available_widgets; 1142 } 1143 1144 /** 1145 * Naturally orders available widgets by name. 1146 * 1147 * @since 3.9.0 1148 * 1149 * @param array $widget_a The first widget to compare. 1150 * @param array $widget_b The second widget to compare. 1151 * @return int Reorder position for the current widget comparison. 1152 */ 1153 protected function _sort_name_callback( $widget_a, $widget_b ) { 1154 return strnatcasecmp( $widget_a['name'], $widget_b['name'] ); 1155 } 1156 1157 /** 1158 * Retrieves the widget control markup. 1159 * 1160 * @since 3.9.0 1161 * 1162 * @param array $args Widget control arguments. 1163 * @return string Widget control form HTML markup. 1164 */ 1165 public function get_widget_control( $args ) { 1166 $args[0]['before_form'] = '<div class="form">'; 1167 $args[0]['after_form'] = '</div><!-- .form -->'; 1168 $args[0]['before_widget_content'] = '<div class="widget-content">'; 1169 $args[0]['after_widget_content'] = '</div><!-- .widget-content -->'; 1170 ob_start(); 1171 wp_widget_control( ...$args ); 1172 $control_tpl = ob_get_clean(); 1173 return $control_tpl; 1174 } 1175 1176 /** 1177 * Retrieves the widget control markup parts. 1178 * 1179 * @since 4.4.0 1180 * 1181 * @param array $args Widget control arguments. 1182 * @return array { 1183 * @type string $control Markup for widget control wrapping form. 1184 * @type string $content The contents of the widget form itself. 1185 * } 1186 */ 1187 public function get_widget_control_parts( $args ) { 1188 $args[0]['before_widget_content'] = '<div class="widget-content">'; 1189 $args[0]['after_widget_content'] = '</div><!-- .widget-content -->'; 1190 $control_markup = $this->get_widget_control( $args ); 1191 1192 $content_start_pos = strpos( $control_markup, $args[0]['before_widget_content'] ); 1193 $content_end_pos = strrpos( $control_markup, $args[0]['after_widget_content'] ); 1194 1195 $control = substr( $control_markup, 0, $content_start_pos + strlen( $args[0]['before_widget_content'] ) ); 1196 $control .= substr( $control_markup, $content_end_pos ); 1197 $content = trim( 1198 substr( 1199 $control_markup, 1200 $content_start_pos + strlen( $args[0]['before_widget_content'] ), 1201 $content_end_pos - $content_start_pos - strlen( $args[0]['before_widget_content'] ) 1202 ) 1203 ); 1204 1205 return compact( 'control', 'content' ); 1206 } 1207 1208 /** 1209 * Adds hooks for the Customizer preview. 1210 * 1211 * @since 3.9.0 1212 */ 1213 public function customize_preview_init() { 1214 add_action( 'wp_enqueue_scripts', array( $this, 'customize_preview_enqueue' ) ); 1215 add_action( 'wp_print_styles', array( $this, 'print_preview_css' ), 1 ); 1216 add_action( 'wp_footer', array( $this, 'export_preview_data' ), 20 ); 1217 } 1218 1219 /** 1220 * Refreshes the nonce for widget updates. 1221 * 1222 * @since 4.2.0 1223 * 1224 * @param array $nonces Array of nonces. 1225 * @return array Array of nonces. 1226 */ 1227 public function refresh_nonces( $nonces ) { 1228 $nonces['update-widget'] = wp_create_nonce( 'update-widget' ); 1229 return $nonces; 1230 } 1231 1232 /** 1233 * Tells the script loader to load the scripts and styles of custom blocks 1234 * if the widgets block editor is enabled. 1235 * 1236 * @since 5.8.0 1237 * 1238 * @param bool $is_block_editor_screen Current decision about loading block assets. 1239 * @return bool Filtered decision about loading block assets. 1240 */ 1241 public function should_load_block_editor_scripts_and_styles( $is_block_editor_screen ) { 1242 if ( wp_use_widgets_block_editor() ) { 1243 return true; 1244 } 1245 1246 return $is_block_editor_screen; 1247 } 1248 1249 /** 1250 * When previewing, ensures the proper previewing widgets are used. 1251 * 1252 * Because wp_get_sidebars_widgets() gets called early at {@see 'init' } (via 1253 * wp_convert_widget_settings()) and can set global variable `$_wp_sidebars_widgets` 1254 * to the value of `get_option( 'sidebars_widgets' )` before the Customizer preview 1255 * filter is added, it has to be reset after the filter has been added. 1256 * 1257 * @since 3.9.0 1258 * 1259 * @param array $sidebars_widgets List of widgets for the current sidebar. 1260 * @return array 1261 */ 1262 public function preview_sidebars_widgets( $sidebars_widgets ) { 1263 $sidebars_widgets = get_option( 'sidebars_widgets', array() ); 1264 1265 unset( $sidebars_widgets['array_version'] ); 1266 return $sidebars_widgets; 1267 } 1268 1269 /** 1270 * Enqueues scripts for the Customizer preview. 1271 * 1272 * @since 3.9.0 1273 */ 1274 public function customize_preview_enqueue() { 1275 wp_enqueue_script( 'customize-preview-widgets' ); 1276 } 1277 1278 /** 1279 * Inserts default style for highlighted widget at early point so theme 1280 * stylesheet can override. 1281 * 1282 * @since 3.9.0 1283 */ 1284 public function print_preview_css() { 1285 ?> 1286 <style> 1287 .widget-customizer-highlighted-widget { 1288 outline: none; 1289 -webkit-box-shadow: 0 0 2px rgba(30, 140, 190, 0.8); 1290 box-shadow: 0 0 2px rgba(30, 140, 190, 0.8); 1291 position: relative; 1292 z-index: 1; 1293 } 1294 </style> 1295 <?php 1296 } 1297 1298 /** 1299 * Communicates the sidebars that appeared on the page at the very end of the page, 1300 * and at the very end of the wp_footer, 1301 * 1302 * @since 3.9.0 1303 * 1304 * @global array $wp_registered_sidebars 1305 * @global array $wp_registered_widgets 1306 */ 1307 public function export_preview_data() { 1308 global $wp_registered_sidebars, $wp_registered_widgets; 1309 1310 $switched_locale = switch_to_user_locale( get_current_user_id() ); 1311 1312 $l10n = array( 1313 'widgetTooltip' => __( 'Shift-click to edit this widget.' ), 1314 ); 1315 1316 if ( $switched_locale ) { 1317 restore_previous_locale(); 1318 } 1319 1320 $rendered_sidebars = array_filter( $this->rendered_sidebars ); 1321 $rendered_widgets = array_filter( $this->rendered_widgets ); 1322 1323 // Prepare Customizer settings to pass to JavaScript. 1324 $settings = array( 1325 'renderedSidebars' => array_fill_keys( array_keys( $rendered_sidebars ), true ), 1326 'renderedWidgets' => array_fill_keys( array_keys( $rendered_widgets ), true ), 1327 'registeredSidebars' => array_values( $wp_registered_sidebars ), 1328 'registeredWidgets' => $wp_registered_widgets, 1329 'l10n' => $l10n, 1330 'selectiveRefreshableWidgets' => $this->get_selective_refreshable_widgets(), 1331 ); 1332 1333 foreach ( $settings['registeredWidgets'] as &$registered_widget ) { 1334 unset( $registered_widget['callback'] ); // May not be JSON-serializable. 1335 } 1336 wp_print_inline_script_tag( 1337 sprintf( 'var _wpWidgetCustomizerPreviewSettings = %s;', wp_json_encode( $settings ) ) 1338 ); 1339 } 1340 1341 /** 1342 * Tracks the widgets that were rendered. 1343 * 1344 * @since 3.9.0 1345 * 1346 * @param array $widget Rendered widget to tally. 1347 */ 1348 public function tally_rendered_widgets( $widget ) { 1349 $this->rendered_widgets[ $widget['id'] ] = true; 1350 } 1351 1352 /** 1353 * Determine if a widget is rendered on the page. 1354 * 1355 * @since 4.0.0 1356 * 1357 * @param string $widget_id Widget ID to check. 1358 * @return bool Whether the widget is rendered. 1359 */ 1360 public function is_widget_rendered( $widget_id ) { 1361 return ! empty( $this->rendered_widgets[ $widget_id ] ); 1362 } 1363 1364 /** 1365 * Determines if a sidebar is rendered on the page. 1366 * 1367 * @since 4.0.0 1368 * 1369 * @param string $sidebar_id Sidebar ID to check. 1370 * @return bool Whether the sidebar is rendered. 1371 */ 1372 public function is_sidebar_rendered( $sidebar_id ) { 1373 return ! empty( $this->rendered_sidebars[ $sidebar_id ] ); 1374 } 1375 1376 /** 1377 * Tallies the sidebars rendered via is_active_sidebar(). 1378 * 1379 * Keep track of the times that is_active_sidebar() is called in the template, 1380 * and assume that this means that the sidebar would be rendered on the template 1381 * if there were widgets populating it. 1382 * 1383 * @since 3.9.0 1384 * 1385 * @param bool $is_active Whether the sidebar is active. 1386 * @param string $sidebar_id Sidebar ID. 1387 * @return bool Whether the sidebar is active. 1388 */ 1389 public function tally_sidebars_via_is_active_sidebar_calls( $is_active, $sidebar_id ) { 1390 if ( is_registered_sidebar( $sidebar_id ) ) { 1391 $this->rendered_sidebars[ $sidebar_id ] = true; 1392 } 1393 1394 /* 1395 * We may need to force this to true, and also force-true the value 1396 * for 'dynamic_sidebar_has_widgets' if we want to ensure that there 1397 * is an area to drop widgets into, if the sidebar is empty. 1398 */ 1399 return $is_active; 1400 } 1401 1402 /** 1403 * Tallies the sidebars rendered via dynamic_sidebar(). 1404 * 1405 * Keep track of the times that dynamic_sidebar() is called in the template, 1406 * and assume this means the sidebar would be rendered on the template if 1407 * there were widgets populating it. 1408 * 1409 * @since 3.9.0 1410 * 1411 * @param bool $has_widgets Whether the current sidebar has widgets. 1412 * @param string $sidebar_id Sidebar ID. 1413 * @return bool Whether the current sidebar has widgets. 1414 */ 1415 public function tally_sidebars_via_dynamic_sidebar_calls( $has_widgets, $sidebar_id ) { 1416 if ( is_registered_sidebar( $sidebar_id ) ) { 1417 $this->rendered_sidebars[ $sidebar_id ] = true; 1418 } 1419 1420 /* 1421 * We may need to force this to true, and also force-true the value 1422 * for 'is_active_sidebar' if we want to ensure there is an area to 1423 * drop widgets into, if the sidebar is empty. 1424 */ 1425 return $has_widgets; 1426 } 1427 1428 /** 1429 * Retrieves MAC for a serialized widget instance string. 1430 * 1431 * Allows values posted back from JS to be rejected if any tampering of the 1432 * data has occurred. 1433 * 1434 * @since 3.9.0 1435 * 1436 * @param string $serialized_instance Widget instance. 1437 * @return string MAC for serialized widget instance. 1438 */ 1439 protected function get_instance_hash_key( $serialized_instance ) { 1440 return wp_hash( $serialized_instance ); 1441 } 1442 1443 /** 1444 * Sanitizes a widget instance. 1445 * 1446 * Unserialize the JS-instance for storing in the options. It's important that this filter 1447 * only get applied to an instance *once*. 1448 * 1449 * @since 3.9.0 1450 * @since 5.8.0 Added the `$id_base` parameter. 1451 * 1452 * @global WP_Widget_Factory $wp_widget_factory 1453 * 1454 * @param array $value Widget instance to sanitize. 1455 * @param string $id_base Optional. Base of the ID of the widget being sanitized. Default null. 1456 * @return array|void Sanitized widget instance. 1457 */ 1458 public function sanitize_widget_instance( $value, $id_base = null ) { 1459 global $wp_widget_factory; 1460 1461 if ( array() === $value ) { 1462 return $value; 1463 } 1464 1465 if ( isset( $value['raw_instance'] ) && $id_base && wp_use_widgets_block_editor() ) { 1466 $widget_object = $wp_widget_factory->get_widget_object( $id_base ); 1467 if ( ! empty( $widget_object->widget_options['show_instance_in_rest'] ) ) { 1468 if ( 'block' === $id_base && ! current_user_can( 'unfiltered_html' ) ) { 1469 /* 1470 * The content of the 'block' widget is not filtered on the fly while editing. 1471 * Filter the content here to prevent vulnerabilities. 1472 */ 1473 $value['raw_instance']['content'] = wp_kses_post( $value['raw_instance']['content'] ); 1474 } 1475 1476 return $value['raw_instance']; 1477 } 1478 } 1479 1480 if ( 1481 empty( $value['is_widget_customizer_js_value'] ) || 1482 empty( $value['instance_hash_key'] ) || 1483 empty( $value['encoded_serialized_instance'] ) 1484 ) { 1485 return; 1486 } 1487 1488 $decoded = base64_decode( $value['encoded_serialized_instance'], true ); 1489 if ( false === $decoded ) { 1490 return; 1491 } 1492 1493 if ( ! hash_equals( $this->get_instance_hash_key( $decoded ), $value['instance_hash_key'] ) ) { 1494 return; 1495 } 1496 1497 $instance = unserialize( $decoded ); 1498 if ( false === $instance ) { 1499 return; 1500 } 1501 1502 return $instance; 1503 } 1504 1505 /** 1506 * Converts a widget instance into JSON-representable format. 1507 * 1508 * @since 3.9.0 1509 * @since 5.8.0 Added the `$id_base` parameter. 1510 * 1511 * @global WP_Widget_Factory $wp_widget_factory 1512 * 1513 * @param array $value Widget instance to convert to JSON. 1514 * @param string $id_base Optional. Base of the ID of the widget being sanitized. Default null. 1515 * @return array JSON-converted widget instance. 1516 */ 1517 public function sanitize_widget_js_instance( $value, $id_base = null ) { 1518 global $wp_widget_factory; 1519 1520 if ( empty( $value['is_widget_customizer_js_value'] ) ) { 1521 $serialized = serialize( $value ); 1522 1523 $js_value = array( 1524 'encoded_serialized_instance' => base64_encode( $serialized ), 1525 'title' => empty( $value['title'] ) ? '' : $value['title'], 1526 'is_widget_customizer_js_value' => true, 1527 'instance_hash_key' => $this->get_instance_hash_key( $serialized ), 1528 ); 1529 1530 if ( $id_base && wp_use_widgets_block_editor() ) { 1531 $widget_object = $wp_widget_factory->get_widget_object( $id_base ); 1532 if ( ! empty( $widget_object->widget_options['show_instance_in_rest'] ) ) { 1533 $js_value['raw_instance'] = (object) $value; 1534 } 1535 } 1536 1537 return $js_value; 1538 } 1539 1540 return $value; 1541 } 1542 1543 /** 1544 * Strips out widget IDs for widgets which are no longer registered. 1545 * 1546 * One example where this might happen is when a plugin orphans a widget 1547 * in a sidebar upon deactivation. 1548 * 1549 * @since 3.9.0 1550 * 1551 * @global array $wp_registered_widgets 1552 * 1553 * @param array $widget_ids List of widget IDs. 1554 * @return array Parsed list of widget IDs. 1555 */ 1556 public function sanitize_sidebar_widgets_js_instance( $widget_ids ) { 1557 global $wp_registered_widgets; 1558 $widget_ids = array_values( array_intersect( $widget_ids, array_keys( $wp_registered_widgets ) ) ); 1559 return $widget_ids; 1560 } 1561 1562 /** 1563 * Finds and invokes the widget update and control callbacks. 1564 * 1565 * Requires that `$_POST` be populated with the instance data. 1566 * 1567 * @since 3.9.0 1568 * 1569 * @global array $wp_registered_widget_updates 1570 * @global array $wp_registered_widget_controls 1571 * 1572 * @param string $widget_id Widget ID. 1573 * @return array|WP_Error Array containing the updated widget information. 1574 * A WP_Error object, otherwise. 1575 */ 1576 public function call_widget_update( $widget_id ) { 1577 global $wp_registered_widget_updates, $wp_registered_widget_controls; 1578 1579 $setting_id = $this->get_setting_id( $widget_id ); 1580 1581 /* 1582 * Make sure that other setting changes have previewed since this widget 1583 * may depend on them (e.g. Menus being present for Navigation Menu widget). 1584 */ 1585 if ( ! did_action( 'customize_preview_init' ) ) { 1586 foreach ( $this->manager->settings() as $setting ) { 1587 if ( $setting->id !== $setting_id ) { 1588 $setting->preview(); 1589 } 1590 } 1591 } 1592 1593 $this->start_capturing_option_updates(); 1594 $parsed_id = $this->parse_widget_id( $widget_id ); 1595 $option_name = 'widget_' . $parsed_id['id_base']; 1596 1597 /* 1598 * If a previously-sanitized instance is provided, populate the input vars 1599 * with its values so that the widget update callback will read this instance 1600 */ 1601 $added_input_vars = array(); 1602 if ( ! empty( $_POST['sanitized_widget_setting'] ) ) { 1603 $sanitized_widget_setting = json_decode( $this->get_post_value( 'sanitized_widget_setting' ), true ); 1604 if ( false === $sanitized_widget_setting ) { 1605 $this->stop_capturing_option_updates(); 1606 return new WP_Error( 'widget_setting_malformed' ); 1607 } 1608 1609 $instance = $this->sanitize_widget_instance( $sanitized_widget_setting, $parsed_id['id_base'] ); 1610 if ( is_null( $instance ) ) { 1611 $this->stop_capturing_option_updates(); 1612 return new WP_Error( 'widget_setting_unsanitized' ); 1613 } 1614 1615 if ( ! is_null( $parsed_id['number'] ) ) { 1616 $value = array(); 1617 $value[ $parsed_id['number'] ] = $instance; 1618 $key = 'widget-' . $parsed_id['id_base']; 1619 $_REQUEST[ $key ] = wp_slash( $value ); 1620 $_POST[ $key ] = $_REQUEST[ $key ]; 1621 $added_input_vars[] = $key; 1622 } else { 1623 foreach ( $instance as $key => $value ) { 1624 $_REQUEST[ $key ] = wp_slash( $value ); 1625 $_POST[ $key ] = $_REQUEST[ $key ]; 1626 $added_input_vars[] = $key; 1627 } 1628 } 1629 } 1630 1631 // Invoke the widget update callback. 1632 foreach ( (array) $wp_registered_widget_updates as $name => $control ) { 1633 if ( $name === $parsed_id['id_base'] && is_callable( $control['callback'] ) ) { 1634 ob_start(); 1635 call_user_func_array( $control['callback'], $control['params'] ); 1636 ob_end_clean(); 1637 break; 1638 } 1639 } 1640 1641 // Clean up any input vars that were manually added. 1642 foreach ( $added_input_vars as $key ) { 1643 unset( $_POST[ $key ] ); 1644 unset( $_REQUEST[ $key ] ); 1645 } 1646 1647 // Make sure the expected option was updated. 1648 if ( 0 !== $this->count_captured_options() ) { 1649 if ( $this->count_captured_options() > 1 ) { 1650 $this->stop_capturing_option_updates(); 1651 return new WP_Error( 'widget_setting_too_many_options' ); 1652 } 1653 1654 $updated_option_name = key( $this->get_captured_options() ); 1655 if ( $updated_option_name !== $option_name ) { 1656 $this->stop_capturing_option_updates(); 1657 return new WP_Error( 'widget_setting_unexpected_option' ); 1658 } 1659 } 1660 1661 // Obtain the widget instance. 1662 $option = $this->get_captured_option( $option_name ); 1663 if ( null !== $parsed_id['number'] ) { 1664 $instance = $option[ $parsed_id['number'] ]; 1665 } else { 1666 $instance = $option; 1667 } 1668 1669 /* 1670 * Override the incoming $_POST['customized'] for a newly-created widget's 1671 * setting with the new $instance so that the preview filter currently 1672 * in place from WP_Customize_Setting::preview() will use this value 1673 * instead of the default widget instance value (an empty array). 1674 */ 1675 $this->manager->set_post_value( $setting_id, $this->sanitize_widget_js_instance( $instance, $parsed_id['id_base'] ) ); 1676 1677 // Obtain the widget control with the updated instance in place. 1678 ob_start(); 1679 $form = $wp_registered_widget_controls[ $widget_id ]; 1680 if ( $form ) { 1681 call_user_func_array( $form['callback'], $form['params'] ); 1682 } 1683 $form = ob_get_clean(); 1684 1685 $this->stop_capturing_option_updates(); 1686 1687 return compact( 'instance', 'form' ); 1688 } 1689 1690 /** 1691 * Updates widget settings asynchronously. 1692 * 1693 * Allows the Customizer to update a widget using its form, but return the new 1694 * instance info via Ajax instead of saving it to the options table. 1695 * 1696 * Most code here copied from wp_ajax_save_widget(). 1697 * 1698 * @since 3.9.0 1699 * 1700 * @see wp_ajax_save_widget() 1701 */ 1702 public function wp_ajax_update_widget() { 1703 1704 if ( ! is_user_logged_in() ) { 1705 wp_die( 0 ); 1706 } 1707 1708 check_ajax_referer( 'update-widget', 'nonce' ); 1709 1710 if ( ! current_user_can( 'edit_theme_options' ) ) { 1711 wp_die( -1 ); 1712 } 1713 1714 if ( empty( $_POST['widget-id'] ) ) { 1715 wp_send_json_error( 'missing_widget-id' ); 1716 } 1717 1718 /** This action is documented in wp-admin/includes/ajax-actions.php */ 1719 do_action( 'load-widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores 1720 1721 /** This action is documented in wp-admin/includes/ajax-actions.php */ 1722 do_action( 'widgets.php' ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores 1723 1724 /** This action is documented in wp-admin/widgets.php */ 1725 do_action( 'sidebar_admin_setup' ); 1726 1727 $widget_id = $this->get_post_value( 'widget-id' ); 1728 $parsed_id = $this->parse_widget_id( $widget_id ); 1729 $id_base = $parsed_id['id_base']; 1730 1731 $is_updating_widget_template = ( 1732 isset( $_POST[ 'widget-' . $id_base ] ) 1733 && 1734 is_array( $_POST[ 'widget-' . $id_base ] ) 1735 && 1736 preg_match( '/__i__|%i%/', key( $_POST[ 'widget-' . $id_base ] ) ) 1737 ); 1738 if ( $is_updating_widget_template ) { 1739 wp_send_json_error( 'template_widget_not_updatable' ); 1740 } 1741 1742 $updated_widget = $this->call_widget_update( $widget_id ); // => {instance,form} 1743 if ( is_wp_error( $updated_widget ) ) { 1744 wp_send_json_error( $updated_widget->get_error_code() ); 1745 } 1746 1747 $form = $updated_widget['form']; 1748 $instance = $this->sanitize_widget_js_instance( $updated_widget['instance'], $id_base ); 1749 1750 wp_send_json_success( compact( 'form', 'instance' ) ); 1751 } 1752 1753 /* 1754 * Selective Refresh Methods 1755 */ 1756 1757 /** 1758 * Filters arguments for dynamic widget partials. 1759 * 1760 * @since 4.5.0 1761 * 1762 * @param array|false $partial_args Partial arguments. 1763 * @param string $partial_id Partial ID. 1764 * @return array (Maybe) modified partial arguments. 1765 */ 1766 public function customize_dynamic_partial_args( $partial_args, $partial_id ) { 1767 if ( ! current_theme_supports( 'customize-selective-refresh-widgets' ) ) { 1768 return $partial_args; 1769 } 1770 1771 if ( preg_match( '/^widget\[(?P<widget_id>.+)\]$/', $partial_id, $matches ) ) { 1772 if ( false === $partial_args ) { 1773 $partial_args = array(); 1774 } 1775 $partial_args = array_merge( 1776 $partial_args, 1777 array( 1778 'type' => 'widget', 1779 'render_callback' => array( $this, 'render_widget_partial' ), 1780 'container_inclusive' => true, 1781 'settings' => array( $this->get_setting_id( $matches['widget_id'] ) ), 1782 'capability' => 'edit_theme_options', 1783 ) 1784 ); 1785 } 1786 1787 return $partial_args; 1788 } 1789 1790 /** 1791 * Adds hooks for selective refresh. 1792 * 1793 * @since 4.5.0 1794 */ 1795 public function selective_refresh_init() { 1796 if ( ! current_theme_supports( 'customize-selective-refresh-widgets' ) ) { 1797 return; 1798 } 1799 add_filter( 'dynamic_sidebar_params', array( $this, 'filter_dynamic_sidebar_params' ) ); 1800 add_filter( 'wp_kses_allowed_html', array( $this, 'filter_wp_kses_allowed_data_attributes' ) ); 1801 add_action( 'dynamic_sidebar_before', array( $this, 'start_dynamic_sidebar' ) ); 1802 add_action( 'dynamic_sidebar_after', array( $this, 'end_dynamic_sidebar' ) ); 1803 } 1804 1805 /** 1806 * Inject selective refresh data attributes into widget container elements. 1807 * 1808 * @since 4.5.0 1809 * 1810 * @param array $params { 1811 * Dynamic sidebar params. 1812 * 1813 * @type array $args Sidebar args. 1814 * @type array $widget_args Widget args. 1815 * } 1816 * @see WP_Customize_Nav_Menus::filter_wp_nav_menu_args() 1817 * 1818 * @return array Params. 1819 */ 1820 public function filter_dynamic_sidebar_params( $params ) { 1821 $sidebar_args = array_merge( 1822 array( 1823 'before_widget' => '', 1824 'after_widget' => '', 1825 ), 1826 $params[0] 1827 ); 1828 1829 // Skip widgets not in a registered sidebar or ones which lack a proper wrapper element to attach the data-* attributes to. 1830 $matches = array(); 1831 $is_valid = ( 1832 isset( $sidebar_args['id'] ) 1833 && 1834 is_registered_sidebar( $sidebar_args['id'] ) 1835 && 1836 ( isset( $this->current_dynamic_sidebar_id_stack[0] ) && $this->current_dynamic_sidebar_id_stack[0] === $sidebar_args['id'] ) 1837 && 1838 preg_match( '#^<(?P<tag_name>\w+)#', $sidebar_args['before_widget'], $matches ) 1839 ); 1840 if ( ! $is_valid ) { 1841 return $params; 1842 } 1843 $this->before_widget_tags_seen[ $matches['tag_name'] ] = true; 1844 1845 $context = array( 1846 'sidebar_id' => $sidebar_args['id'], 1847 ); 1848 if ( isset( $this->context_sidebar_instance_number ) ) { 1849 $context['sidebar_instance_number'] = $this->context_sidebar_instance_number; 1850 } elseif ( isset( $sidebar_args['id'] ) && isset( $this->sidebar_instance_count[ $sidebar_args['id'] ] ) ) { 1851 $context['sidebar_instance_number'] = $this->sidebar_instance_count[ $sidebar_args['id'] ]; 1852 } 1853 1854 $attributes = sprintf( ' data-customize-partial-id="%s"', esc_attr( 'widget[' . $sidebar_args['widget_id'] . ']' ) ); 1855 $attributes .= ' data-customize-partial-type="widget"'; 1856 $attributes .= sprintf( ' data-customize-partial-placement-context="%s"', esc_attr( wp_json_encode( $context ) ) ); 1857 $attributes .= sprintf( ' data-customize-widget-id="%s"', esc_attr( $sidebar_args['widget_id'] ) ); 1858 $sidebar_args['before_widget'] = preg_replace( '#^(<\w+)#', '$1 ' . $attributes, $sidebar_args['before_widget'] ); 1859 1860 $params[0] = $sidebar_args; 1861 return $params; 1862 } 1863 1864 /** 1865 * List of the tag names seen for before_widget strings. 1866 * 1867 * This is used in the {@see 'filter_wp_kses_allowed_html'} filter to ensure that the 1868 * data-* attributes can be allowed. 1869 * 1870 * @since 4.5.0 1871 * @var array 1872 */ 1873 protected $before_widget_tags_seen = array(); 1874 1875 /** 1876 * Ensures the HTML data-* attributes for selective refresh are allowed by kses. 1877 * 1878 * This is needed in case the `$before_widget` is run through wp_kses() when printed. 1879 * 1880 * @since 4.5.0 1881 * 1882 * @param array $allowed_html Allowed HTML. 1883 * @return array (Maybe) modified allowed HTML. 1884 */ 1885 public function filter_wp_kses_allowed_data_attributes( $allowed_html ) { 1886 foreach ( array_keys( $this->before_widget_tags_seen ) as $tag_name ) { 1887 if ( ! isset( $allowed_html[ $tag_name ] ) ) { 1888 $allowed_html[ $tag_name ] = array(); 1889 } 1890 $allowed_html[ $tag_name ] = array_merge( 1891 $allowed_html[ $tag_name ], 1892 array_fill_keys( 1893 array( 1894 'data-customize-partial-id', 1895 'data-customize-partial-type', 1896 'data-customize-partial-placement-context', 1897 'data-customize-partial-widget-id', 1898 'data-customize-partial-options', 1899 ), 1900 true 1901 ) 1902 ); 1903 } 1904 return $allowed_html; 1905 } 1906 1907 /** 1908 * Keep track of the number of times that dynamic_sidebar() was called for a given sidebar index. 1909 * 1910 * This helps facilitate the uncommon scenario where a single sidebar is rendered multiple times on a template. 1911 * 1912 * @since 4.5.0 1913 * @var array 1914 */ 1915 protected $sidebar_instance_count = array(); 1916 1917 /** 1918 * The current request's sidebar_instance_number context. 1919 * 1920 * @since 4.5.0 1921 * @var int|null 1922 */ 1923 protected $context_sidebar_instance_number; 1924 1925 /** 1926 * Current sidebar ID being rendered. 1927 * 1928 * @since 4.5.0 1929 * @var array 1930 */ 1931 protected $current_dynamic_sidebar_id_stack = array(); 1932 1933 /** 1934 * Begins keeping track of the current sidebar being rendered. 1935 * 1936 * Insert marker before widgets are rendered in a dynamic sidebar. 1937 * 1938 * @since 4.5.0 1939 * 1940 * @param int|string $index Index, name, or ID of the dynamic sidebar. 1941 */ 1942 public function start_dynamic_sidebar( $index ) { 1943 array_unshift( $this->current_dynamic_sidebar_id_stack, $index ); 1944 if ( ! isset( $this->sidebar_instance_count[ $index ] ) ) { 1945 $this->sidebar_instance_count[ $index ] = 0; 1946 } 1947 $this->sidebar_instance_count[ $index ] += 1; 1948 if ( ! $this->manager->selective_refresh->is_render_partials_request() ) { 1949 printf( "\n<!--dynamic_sidebar_before:%s:%d-->\n", esc_html( $index ), (int) $this->sidebar_instance_count[ $index ] ); 1950 } 1951 } 1952 1953 /** 1954 * Finishes keeping track of the current sidebar being rendered. 1955 * 1956 * Inserts a marker after widgets are rendered in a dynamic sidebar. 1957 * 1958 * @since 4.5.0 1959 * 1960 * @param int|string $index Index, name, or ID of the dynamic sidebar. 1961 */ 1962 public function end_dynamic_sidebar( $index ) { 1963 array_shift( $this->current_dynamic_sidebar_id_stack ); 1964 if ( ! $this->manager->selective_refresh->is_render_partials_request() ) { 1965 printf( "\n<!--dynamic_sidebar_after:%s:%d-->\n", esc_html( $index ), (int) $this->sidebar_instance_count[ $index ] ); 1966 } 1967 } 1968 1969 /** 1970 * Current sidebar being rendered. 1971 * 1972 * @since 4.5.0 1973 * @var string|null 1974 */ 1975 protected $rendering_widget_id; 1976 1977 /** 1978 * Current widget being rendered. 1979 * 1980 * @since 4.5.0 1981 * @var string|null 1982 */ 1983 protected $rendering_sidebar_id; 1984 1985 /** 1986 * Filters sidebars_widgets to ensure the currently-rendered widget is the only widget in the current sidebar. 1987 * 1988 * @since 4.5.0 1989 * 1990 * @param array $sidebars_widgets Sidebars widgets. 1991 * @return array Filtered sidebars widgets. 1992 */ 1993 public function filter_sidebars_widgets_for_rendering_widget( $sidebars_widgets ) { 1994 $sidebars_widgets[ $this->rendering_sidebar_id ] = array( $this->rendering_widget_id ); 1995 return $sidebars_widgets; 1996 } 1997 1998 /** 1999 * Renders a specific widget using the supplied sidebar arguments. 2000 * 2001 * @since 4.5.0 2002 * 2003 * @see dynamic_sidebar() 2004 * 2005 * @param WP_Customize_Partial $partial Partial. 2006 * @param array $context { 2007 * Sidebar args supplied as container context. 2008 * 2009 * @type string $sidebar_id ID for sidebar for widget to render into. 2010 * @type int $sidebar_instance_number Disambiguating instance number. 2011 * } 2012 * @return string|false 2013 */ 2014 public function render_widget_partial( $partial, $context ) { 2015 $id_data = $partial->id_data(); 2016 $widget_id = array_shift( $id_data['keys'] ); 2017 2018 if ( ! is_array( $context ) 2019 || empty( $context['sidebar_id'] ) 2020 || ! is_registered_sidebar( $context['sidebar_id'] ) 2021 ) { 2022 return false; 2023 } 2024 2025 $this->rendering_sidebar_id = $context['sidebar_id']; 2026 2027 if ( isset( $context['sidebar_instance_number'] ) ) { 2028 $this->context_sidebar_instance_number = (int) $context['sidebar_instance_number']; 2029 } 2030 2031 // Filter sidebars_widgets so that only the queried widget is in the sidebar. 2032 $this->rendering_widget_id = $widget_id; 2033 2034 $filter_callback = array( $this, 'filter_sidebars_widgets_for_rendering_widget' ); 2035 add_filter( 'sidebars_widgets', $filter_callback, 1000 ); 2036 2037 // Render the widget. 2038 ob_start(); 2039 $this->rendering_sidebar_id = $context['sidebar_id']; 2040 dynamic_sidebar( $this->rendering_sidebar_id ); 2041 $container = ob_get_clean(); 2042 2043 // Reset variables for next partial render. 2044 remove_filter( 'sidebars_widgets', $filter_callback, 1000 ); 2045 2046 $this->context_sidebar_instance_number = null; 2047 $this->rendering_sidebar_id = null; 2048 $this->rendering_widget_id = null; 2049 2050 return $container; 2051 } 2052 2053 // 2054 // Option Update Capturing. 2055 // 2056 2057 /** 2058 * List of captured widget option updates. 2059 * 2060 * @since 3.9.0 2061 * @var array $_captured_options Values updated while option capture is happening. 2062 */ 2063 protected $_captured_options = array(); 2064 2065 /** 2066 * Whether option capture is currently happening. 2067 * 2068 * @since 3.9.0 2069 * @var bool $_is_current Whether option capture is currently happening or not. 2070 */ 2071 protected $_is_capturing_option_updates = false; 2072 2073 /** 2074 * Determines whether the captured option update should be ignored. 2075 * 2076 * @since 3.9.0 2077 * 2078 * @param string $option_name Option name. 2079 * @return bool Whether the option capture is ignored. 2080 */ 2081 protected function is_option_capture_ignored( $option_name ) { 2082 return ( str_starts_with( $option_name, '_transient_' ) ); 2083 } 2084 2085 /** 2086 * Retrieves captured widget option updates. 2087 * 2088 * @since 3.9.0 2089 * 2090 * @return array Array of captured options. 2091 */ 2092 protected function get_captured_options() { 2093 return $this->_captured_options; 2094 } 2095 2096 /** 2097 * Retrieves the option that was captured from being saved. 2098 * 2099 * @since 4.2.0 2100 * 2101 * @param string $option_name Option name. 2102 * @param mixed $default_value Optional. Default value to return if the option does not exist. Default false. 2103 * @return mixed Value set for the option. 2104 */ 2105 protected function get_captured_option( $option_name, $default_value = false ) { 2106 if ( array_key_exists( $option_name, $this->_captured_options ) ) { 2107 $value = $this->_captured_options[ $option_name ]; 2108 } else { 2109 $value = $default_value; 2110 } 2111 return $value; 2112 } 2113 2114 /** 2115 * Retrieves the number of captured widget option updates. 2116 * 2117 * @since 3.9.0 2118 * 2119 * @return int Number of updated options. 2120 */ 2121 protected function count_captured_options() { 2122 return count( $this->_captured_options ); 2123 } 2124 2125 /** 2126 * Begins keeping track of changes to widget options, caching new values. 2127 * 2128 * @since 3.9.0 2129 */ 2130 protected function start_capturing_option_updates() { 2131 if ( $this->_is_capturing_option_updates ) { 2132 return; 2133 } 2134 2135 $this->_is_capturing_option_updates = true; 2136 2137 add_filter( 'pre_update_option', array( $this, 'capture_filter_pre_update_option' ), 10, 3 ); 2138 } 2139 2140 /** 2141 * Pre-filters captured option values before updating. 2142 * 2143 * @since 3.9.0 2144 * 2145 * @param mixed $new_value The new option value. 2146 * @param string $option_name Name of the option. 2147 * @param mixed $old_value The old option value. 2148 * @return mixed Filtered option value. 2149 */ 2150 public function capture_filter_pre_update_option( $new_value, $option_name, $old_value ) { 2151 if ( $this->is_option_capture_ignored( $option_name ) ) { 2152 return $new_value; 2153 } 2154 2155 if ( ! isset( $this->_captured_options[ $option_name ] ) ) { 2156 add_filter( "pre_option_{$option_name}", array( $this, 'capture_filter_pre_get_option' ) ); 2157 } 2158 2159 $this->_captured_options[ $option_name ] = $new_value; 2160 2161 return $old_value; 2162 } 2163 2164 /** 2165 * Pre-filters captured option values before retrieving. 2166 * 2167 * @since 3.9.0 2168 * 2169 * @param mixed $value Value to return instead of the option value. 2170 * @return mixed Filtered option value. 2171 */ 2172 public function capture_filter_pre_get_option( $value ) { 2173 $option_name = preg_replace( '/^pre_option_/', '', current_filter() ); 2174 2175 if ( isset( $this->_captured_options[ $option_name ] ) ) { 2176 $value = $this->_captured_options[ $option_name ]; 2177 2178 /** This filter is documented in wp-includes/option.php */ 2179 $value = apply_filters( 'option_' . $option_name, $value, $option_name ); 2180 } 2181 2182 return $value; 2183 } 2184 2185 /** 2186 * Undoes any changes to the options since options capture began. 2187 * 2188 * @since 3.9.0 2189 */ 2190 protected function stop_capturing_option_updates() { 2191 if ( ! $this->_is_capturing_option_updates ) { 2192 return; 2193 } 2194 2195 remove_filter( 'pre_update_option', array( $this, 'capture_filter_pre_update_option' ), 10 ); 2196 2197 foreach ( array_keys( $this->_captured_options ) as $option_name ) { 2198 remove_filter( "pre_option_{$option_name}", array( $this, 'capture_filter_pre_get_option' ) ); 2199 } 2200 2201 $this->_captured_options = array(); 2202 $this->_is_capturing_option_updates = false; 2203 } 2204 2205 /** 2206 * {@internal Missing Summary} 2207 * 2208 * See the {@see 'customize_dynamic_setting_args'} filter. 2209 * 2210 * @since 3.9.0 2211 * @deprecated 4.2.0 Deprecated in favor of the {@see 'customize_dynamic_setting_args'} filter. 2212 */ 2213 public function setup_widget_addition_previews() { 2214 _deprecated_function( __METHOD__, '4.2.0', 'customize_dynamic_setting_args' ); 2215 } 2216 2217 /** 2218 * {@internal Missing Summary} 2219 * 2220 * See the {@see 'customize_dynamic_setting_args'} filter. 2221 * 2222 * @since 3.9.0 2223 * @deprecated 4.2.0 Deprecated in favor of the {@see 'customize_dynamic_setting_args'} filter. 2224 */ 2225 public function prepreview_added_sidebars_widgets() { 2226 _deprecated_function( __METHOD__, '4.2.0', 'customize_dynamic_setting_args' ); 2227 } 2228 2229 /** 2230 * {@internal Missing Summary} 2231 * 2232 * See the {@see 'customize_dynamic_setting_args'} filter. 2233 * 2234 * @since 3.9.0 2235 * @deprecated 4.2.0 Deprecated in favor of the {@see 'customize_dynamic_setting_args'} filter. 2236 */ 2237 public function prepreview_added_widget_instance() { 2238 _deprecated_function( __METHOD__, '4.2.0', 'customize_dynamic_setting_args' ); 2239 } 2240 2241 /** 2242 * {@internal Missing Summary} 2243 * 2244 * See the {@see 'customize_dynamic_setting_args'} filter. 2245 * 2246 * @since 3.9.0 2247 * @deprecated 4.2.0 Deprecated in favor of the {@see 'customize_dynamic_setting_args'} filter. 2248 */ 2249 public function remove_prepreview_filters() { 2250 _deprecated_function( __METHOD__, '4.2.0', 'customize_dynamic_setting_args' ); 2251 } 2252 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Sat Jun 7 08:20:01 2025 | Cross-referenced by PHPXref |