| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * Core Widgets API 4 * 5 * This API is used for creating dynamic sidebar without hardcoding functionality into 6 * themes. 7 * 8 * Includes both internal WordPress routines and theme-use routines. 9 * 10 * This functionality was found in a plugin before the WordPress 2.2 release, which 11 * included it in the core from that point on. 12 * 13 * @link https://wordpress.org/documentation/article/manage-wordpress-widgets/ 14 * @link https://developer.wordpress.org/themes/functionality/widgets/ 15 * 16 * @package WordPress 17 * @subpackage Widgets 18 * @since 2.2.0 19 */ 20 21 // 22 // Global Variables. 23 // 24 25 /** @ignore */ 26 global $wp_registered_sidebars, $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates; 27 28 /** 29 * Stores the sidebars, since many themes can have more than one. 30 * 31 * @since 2.2.0 32 * 33 * @global array $wp_registered_sidebars The registered sidebars. 34 */ 35 $wp_registered_sidebars = array(); 36 37 /** 38 * Stores the registered widgets. 39 * 40 * @since 2.2.0 41 * 42 * @global array $wp_registered_widgets The registered widgets. 43 */ 44 $wp_registered_widgets = array(); 45 46 /** 47 * Stores the registered widget controls (options). 48 * 49 * @since 2.2.0 50 * 51 * @global array $wp_registered_widget_controls The registered widget controls. 52 */ 53 $wp_registered_widget_controls = array(); 54 55 /** 56 * Stores the registered widget updates. 57 * 58 * @since 2.8.0 59 * 60 * @global array $wp_registered_widget_updates The registered widget updates. 61 */ 62 $wp_registered_widget_updates = array(); 63 64 /** 65 * Private 66 * 67 * @global array $_wp_sidebars_widgets 68 */ 69 $_wp_sidebars_widgets = array(); 70 71 /** 72 * Private 73 * 74 * @global array $_wp_deprecated_widgets_callbacks 75 */ 76 $GLOBALS['_wp_deprecated_widgets_callbacks'] = array( 77 'wp_widget_pages', 78 'wp_widget_pages_control', 79 'wp_widget_calendar', 80 'wp_widget_calendar_control', 81 'wp_widget_archives', 82 'wp_widget_archives_control', 83 'wp_widget_links', 84 'wp_widget_meta', 85 'wp_widget_meta_control', 86 'wp_widget_search', 87 'wp_widget_recent_entries', 88 'wp_widget_recent_entries_control', 89 'wp_widget_tag_cloud', 90 'wp_widget_tag_cloud_control', 91 'wp_widget_categories', 92 'wp_widget_categories_control', 93 'wp_widget_text', 94 'wp_widget_text_control', 95 'wp_widget_rss', 96 'wp_widget_rss_control', 97 'wp_widget_recent_comments', 98 'wp_widget_recent_comments_control', 99 ); 100 101 // 102 // Template tags & API functions. 103 // 104 105 /** 106 * Registers a widget. 107 * 108 * Registers a WP_Widget widget 109 * 110 * @since 2.8.0 111 * @since 4.6.0 Updated the `$widget` parameter to also accept a WP_Widget instance object 112 * instead of simply a `WP_Widget` subclass name. 113 * 114 * @see WP_Widget 115 * 116 * @global WP_Widget_Factory $wp_widget_factory 117 * 118 * @param string|WP_Widget $widget Either the name of a `WP_Widget` subclass or an instance of a `WP_Widget` subclass. 119 */ 120 function register_widget( $widget ) { 121 global $wp_widget_factory; 122 123 $wp_widget_factory->register( $widget ); 124 } 125 126 /** 127 * Unregisters a widget. 128 * 129 * Unregisters a WP_Widget widget. Useful for un-registering default widgets. 130 * Run within a function hooked to the {@see 'widgets_init'} action. 131 * 132 * @since 2.8.0 133 * @since 4.6.0 Updated the `$widget` parameter to also accept a WP_Widget instance object 134 * instead of simply a `WP_Widget` subclass name. 135 * 136 * @see WP_Widget 137 * 138 * @global WP_Widget_Factory $wp_widget_factory 139 * 140 * @param string|WP_Widget $widget Either the name of a `WP_Widget` subclass or an instance of a `WP_Widget` subclass. 141 */ 142 function unregister_widget( $widget ) { 143 global $wp_widget_factory; 144 145 $wp_widget_factory->unregister( $widget ); 146 } 147 148 /** 149 * Creates multiple sidebars. 150 * 151 * If you wanted to quickly create multiple sidebars for a theme or internally. 152 * This function will allow you to do so. If you don't pass the 'name' and/or 153 * 'id' in `$args`, then they will be built for you. 154 * 155 * @since 2.2.0 156 * 157 * @see register_sidebar() The second parameter is documented by register_sidebar() and is the same here. 158 * 159 * @global array $wp_registered_sidebars The new sidebars are stored in this array by sidebar ID. 160 * 161 * @param int $number Optional. Number of sidebars to create. Default 1. 162 * @param array|string $args { 163 * Optional. Array or string of arguments for building a sidebar. 164 * 165 * @type string $id The base string of the unique identifier for each sidebar. If provided, and multiple 166 * sidebars are being defined, the ID will have "-2" appended, and so on. 167 * Default 'sidebar-' followed by the number the sidebar creation is currently at. 168 * @type string $name The name or title for the sidebars displayed in the admin dashboard. If registering 169 * more than one sidebar, include '%d' in the string as a placeholder for the uniquely 170 * assigned number for each sidebar. 171 * Default 'Sidebar' for the first sidebar, otherwise 'Sidebar %d'. 172 * } 173 */ 174 function register_sidebars( $number = 1, $args = array() ) { 175 global $wp_registered_sidebars; 176 $number = (int) $number; 177 178 if ( is_string( $args ) ) { 179 parse_str( $args, $args ); 180 } 181 182 for ( $i = 1; $i <= $number; $i++ ) { 183 $_args = $args; 184 185 if ( $number > 1 ) { 186 if ( isset( $args['name'] ) ) { 187 $_args['name'] = sprintf( $args['name'], $i ); 188 } else { 189 /* translators: %d: Sidebar number. */ 190 $_args['name'] = sprintf( __( 'Sidebar %d' ), $i ); 191 } 192 } else { 193 $_args['name'] = $args['name'] ?? __( 'Sidebar' ); 194 } 195 196 /* 197 * Custom specified ID's are suffixed if they exist already. 198 * Automatically generated sidebar names need to be suffixed regardless starting at -0. 199 */ 200 if ( isset( $args['id'] ) ) { 201 $_args['id'] = $args['id']; 202 $n = 2; // Start at -2 for conflicting custom IDs. 203 while ( is_registered_sidebar( $_args['id'] ) ) { 204 $_args['id'] = $args['id'] . '-' . $n++; 205 } 206 } else { 207 $n = count( $wp_registered_sidebars ); 208 do { 209 $_args['id'] = 'sidebar-' . ++$n; 210 } while ( is_registered_sidebar( $_args['id'] ) ); 211 } 212 register_sidebar( $_args ); 213 } 214 } 215 216 /** 217 * Builds the definition for a single sidebar and returns the ID. 218 * 219 * Accepts either a string or an array and then parses that against a set 220 * of default arguments for the new sidebar. WordPress will automatically 221 * generate a sidebar ID and name based on the current number of registered 222 * sidebars if those arguments are not included. 223 * 224 * When allowing for automatic generation of the name and ID parameters, keep 225 * in mind that the incrementor for your sidebar can change over time depending 226 * on what other plugins and themes are installed. 227 * 228 * If theme support for 'widgets' has not yet been added when this function is 229 * called, it will be automatically enabled through the use of add_theme_support(). 230 * 231 * @since 2.2.0 232 * @since 5.6.0 Added the `before_sidebar` and `after_sidebar` arguments. 233 * @since 5.9.0 Added the `show_in_rest` argument. 234 * 235 * @global array $wp_registered_sidebars The registered sidebars. 236 * 237 * @param array|string $args { 238 * Optional. Array or string of arguments for the sidebar being registered. 239 * 240 * @type string $name The name or title of the sidebar displayed in the Widgets 241 * interface. Default 'Sidebar $instance'. 242 * @type string $id The unique identifier by which the sidebar will be called. 243 * Default 'sidebar-$instance'. 244 * @type string $description Description of the sidebar, displayed in the Widgets interface. 245 * Default empty string. 246 * @type string $class Extra CSS class to assign to the sidebar in the Widgets interface. 247 * Default empty. 248 * @type string $before_widget HTML content to prepend to each widget's HTML output when assigned 249 * to this sidebar. Receives the widget's ID attribute as `%1$s` 250 * and class name as `%2$s`. Default is an opening list item element. 251 * @type string $after_widget HTML content to append to each widget's HTML output when assigned 252 * to this sidebar. Default is a closing list item element. 253 * @type string $before_title HTML content to prepend to the sidebar title when displayed. 254 * Default is an opening h2 element. 255 * @type string $after_title HTML content to append to the sidebar title when displayed. 256 * Default is a closing h2 element. 257 * @type string $before_sidebar HTML content to prepend to the sidebar when displayed. 258 * Receives the `$id` argument as `%1$s` and `$class` as `%2$s`. 259 * Outputs after the {@see 'dynamic_sidebar_before'} action. 260 * Default empty string. 261 * @type string $after_sidebar HTML content to append to the sidebar when displayed. 262 * Outputs before the {@see 'dynamic_sidebar_after'} action. 263 * Default empty string. 264 * @type bool $show_in_rest Whether to show this sidebar publicly in the REST API. 265 * Defaults to only showing the sidebar to administrator users. 266 * } 267 * @return string Sidebar ID added to $wp_registered_sidebars global. 268 */ 269 function register_sidebar( $args = array() ) { 270 global $wp_registered_sidebars; 271 272 $i = count( $wp_registered_sidebars ) + 1; 273 274 $id_is_empty = empty( $args['id'] ); 275 276 $defaults = array( 277 /* translators: %d: Sidebar number. */ 278 'name' => sprintf( __( 'Sidebar %d' ), $i ), 279 'id' => "sidebar-$i", 280 'description' => '', 281 'class' => '', 282 'before_widget' => '<li id="%1$s" class="widget %2$s">', 283 'after_widget' => "</li>\n", 284 'before_title' => '<h2 class="widgettitle">', 285 'after_title' => "</h2>\n", 286 'before_sidebar' => '', 287 'after_sidebar' => '', 288 'show_in_rest' => false, 289 ); 290 291 /** 292 * Filters the sidebar default arguments. 293 * 294 * @since 5.3.0 295 * 296 * @see register_sidebar() 297 * 298 * @param array $defaults The default sidebar arguments. 299 */ 300 $sidebar = wp_parse_args( $args, apply_filters( 'register_sidebar_defaults', $defaults ) ); 301 302 if ( $id_is_empty ) { 303 _doing_it_wrong( 304 __FUNCTION__, 305 sprintf( 306 /* translators: 1: The 'id' argument, 2: Sidebar name, 3: Recommended 'id' value. */ 307 __( 'No %1$s was set in the arguments array for the "%2$s" sidebar. Defaulting to "%3$s". Manually set the %1$s to "%3$s" to silence this notice and keep existing sidebar content.' ), 308 '<code>id</code>', 309 $sidebar['name'], 310 $sidebar['id'] 311 ), 312 '4.2.0' 313 ); 314 } 315 316 $wp_registered_sidebars[ $sidebar['id'] ] = $sidebar; 317 318 add_theme_support( 'widgets' ); 319 320 /** 321 * Fires once a sidebar has been registered. 322 * 323 * @since 3.0.0 324 * 325 * @param array $sidebar Parsed arguments for the registered sidebar. 326 */ 327 do_action( 'register_sidebar', $sidebar ); 328 329 return $sidebar['id']; 330 } 331 332 /** 333 * Removes a sidebar from the list. 334 * 335 * @since 2.2.0 336 * 337 * @global array $wp_registered_sidebars The registered sidebars. 338 * 339 * @param string|int $sidebar_id The ID of the sidebar when it was registered. 340 */ 341 function unregister_sidebar( $sidebar_id ) { 342 global $wp_registered_sidebars; 343 344 unset( $wp_registered_sidebars[ $sidebar_id ] ); 345 } 346 347 /** 348 * Checks if a sidebar is registered. 349 * 350 * @since 4.4.0 351 * 352 * @global array $wp_registered_sidebars The registered sidebars. 353 * 354 * @param string|int $sidebar_id The ID of the sidebar when it was registered. 355 * @return bool True if the sidebar is registered, false otherwise. 356 */ 357 function is_registered_sidebar( $sidebar_id ) { 358 global $wp_registered_sidebars; 359 360 return isset( $wp_registered_sidebars[ $sidebar_id ] ); 361 } 362 363 /** 364 * Registers an instance of a widget. 365 * 366 * The default widget option is 'classname' that can be overridden. 367 * 368 * The function can also be used to un-register widgets when `$output_callback` 369 * parameter is an empty string. 370 * 371 * @since 2.2.0 372 * @since 5.3.0 Formalized the existing and already documented `...$params` parameter 373 * by adding it to the function signature. 374 * @since 5.8.0 Added show_instance_in_rest option. 375 * 376 * @global array $wp_registered_widgets Uses stored registered widgets. 377 * @global array $wp_registered_widget_controls Stores the registered widget controls (options). 378 * @global array $wp_registered_widget_updates The registered widget updates. 379 * @global array $_wp_deprecated_widgets_callbacks 380 * 381 * @param int|string $id Widget ID. 382 * @param string $name Widget display title. 383 * @param callable $output_callback Run when widget is called. 384 * @param array $options { 385 * Optional. An array of supplementary widget options for the instance. 386 * 387 * @type string $classname Class name for the widget's HTML container. Default is a shortened 388 * version of the output callback name. 389 * @type string $description Widget description for display in the widget administration 390 * panel and/or theme. 391 * @type bool $show_instance_in_rest Whether to show the widget's instance settings in the REST API. 392 * Only available for WP_Widget based widgets. 393 * } 394 * @param mixed ...$params Optional additional parameters to pass to the callback function when it's called. 395 */ 396 function wp_register_sidebar_widget( $id, $name, $output_callback, $options = array(), ...$params ) { 397 global $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates, $_wp_deprecated_widgets_callbacks; 398 399 $id = strtolower( $id ); 400 401 if ( empty( $output_callback ) ) { 402 unset( $wp_registered_widgets[ $id ] ); 403 return; 404 } 405 406 $id_base = _get_widget_id_base( $id ); 407 if ( in_array( $output_callback, $_wp_deprecated_widgets_callbacks, true ) && ! is_callable( $output_callback ) ) { 408 unset( $wp_registered_widget_controls[ $id ] ); 409 unset( $wp_registered_widget_updates[ $id_base ] ); 410 return; 411 } 412 413 $defaults = array( 'classname' => $output_callback ); 414 $options = wp_parse_args( $options, $defaults ); 415 $widget = array( 416 'name' => $name, 417 'id' => $id, 418 'callback' => $output_callback, 419 'params' => $params, 420 ); 421 $widget = array_merge( $widget, $options ); 422 423 if ( is_callable( $output_callback ) && ( ! isset( $wp_registered_widgets[ $id ] ) || did_action( 'widgets_init' ) ) ) { 424 425 /** 426 * Fires once for each registered widget. 427 * 428 * @since 3.0.0 429 * 430 * @param array $widget An array of default widget arguments. 431 */ 432 do_action( 'wp_register_sidebar_widget', $widget ); 433 $wp_registered_widgets[ $id ] = $widget; 434 } 435 } 436 437 /** 438 * Retrieves description for widget. 439 * 440 * When registering widgets, the options can also include 'description' that 441 * describes the widget for display on the widget administration panel or 442 * in the theme. 443 * 444 * @since 2.5.0 445 * 446 * @global array $wp_registered_widgets The registered widgets. 447 * 448 * @param int|string $id Widget ID. 449 * @return string|null Widget description, if available. 450 */ 451 function wp_widget_description( $id ) { 452 if ( ! is_scalar( $id ) ) { 453 return null; 454 } 455 456 global $wp_registered_widgets; 457 458 if ( isset( $wp_registered_widgets[ $id ]['description'] ) ) { 459 return esc_html( $wp_registered_widgets[ $id ]['description'] ); 460 } 461 return null; 462 } 463 464 /** 465 * Retrieves description for a sidebar. 466 * 467 * When registering sidebars a 'description' parameter can be included that 468 * describes the sidebar for display on the widget administration panel. 469 * 470 * @since 2.9.0 471 * 472 * @global array $wp_registered_sidebars The registered sidebars. 473 * 474 * @param string $id sidebar ID. 475 * @return string|null Sidebar description, if available. 476 */ 477 function wp_sidebar_description( $id ) { 478 if ( ! is_scalar( $id ) ) { 479 return null; 480 } 481 482 global $wp_registered_sidebars; 483 484 if ( isset( $wp_registered_sidebars[ $id ]['description'] ) ) { 485 return wp_kses( $wp_registered_sidebars[ $id ]['description'], 'sidebar_description' ); 486 } 487 return null; 488 } 489 490 /** 491 * Remove widget from sidebar. 492 * 493 * @since 2.2.0 494 * 495 * @param int|string $id Widget ID. 496 */ 497 function wp_unregister_sidebar_widget( $id ) { 498 499 /** 500 * Fires just before a widget is removed from a sidebar. 501 * 502 * @since 3.0.0 503 * 504 * @param int|string $id The widget ID. 505 */ 506 do_action( 'wp_unregister_sidebar_widget', $id ); 507 508 wp_register_sidebar_widget( $id, '', '' ); 509 wp_unregister_widget_control( $id ); 510 } 511 512 /** 513 * Registers widget control callback for customizing options. 514 * 515 * @since 2.2.0 516 * @since 5.3.0 Formalized the existing and already documented `...$params` parameter 517 * by adding it to the function signature. 518 * 519 * @global array $wp_registered_widget_controls The registered widget controls. 520 * @global array $wp_registered_widget_updates The registered widget updates. 521 * @global array $wp_registered_widgets The registered widgets. 522 * @global array $_wp_deprecated_widgets_callbacks 523 * 524 * @param int|string $id Sidebar ID. 525 * @param string $name Sidebar display name. 526 * @param callable $control_callback Run when sidebar is displayed. 527 * @param array $options { 528 * Optional. Array or string of control options. Default empty array. 529 * 530 * @type int $height Never used. Default 200. 531 * @type int $width Width of the fully expanded control form (but try hard to use the default width). 532 * Default 250. 533 * @type int|string $id_base Required for multi-widgets, i.e widgets that allow multiple instances such as the 534 * text widget. The widget ID will end up looking like `{$id_base}-{$unique_number}`. 535 * } 536 * @param mixed ...$params Optional additional parameters to pass to the callback function when it's called. 537 */ 538 function wp_register_widget_control( $id, $name, $control_callback, $options = array(), ...$params ) { 539 global $wp_registered_widget_controls, $wp_registered_widget_updates, $wp_registered_widgets, $_wp_deprecated_widgets_callbacks; 540 541 $id = strtolower( $id ); 542 $id_base = _get_widget_id_base( $id ); 543 544 if ( empty( $control_callback ) ) { 545 unset( $wp_registered_widget_controls[ $id ] ); 546 unset( $wp_registered_widget_updates[ $id_base ] ); 547 return; 548 } 549 550 if ( in_array( $control_callback, $_wp_deprecated_widgets_callbacks, true ) && ! is_callable( $control_callback ) ) { 551 unset( $wp_registered_widgets[ $id ] ); 552 return; 553 } 554 555 if ( isset( $wp_registered_widget_controls[ $id ] ) && ! did_action( 'widgets_init' ) ) { 556 return; 557 } 558 559 $defaults = array( 560 'width' => 250, 561 'height' => 200, 562 ); // Height is never used. 563 $options = wp_parse_args( $options, $defaults ); 564 $options['width'] = (int) $options['width']; 565 $options['height'] = (int) $options['height']; 566 567 $widget = array( 568 'name' => $name, 569 'id' => $id, 570 'callback' => $control_callback, 571 'params' => $params, 572 ); 573 $widget = array_merge( $widget, $options ); 574 575 $wp_registered_widget_controls[ $id ] = $widget; 576 577 if ( isset( $wp_registered_widget_updates[ $id_base ] ) ) { 578 return; 579 } 580 581 if ( isset( $widget['params'][0]['number'] ) ) { 582 $widget['params'][0]['number'] = -1; 583 } 584 585 unset( $widget['width'], $widget['height'], $widget['name'], $widget['id'] ); 586 $wp_registered_widget_updates[ $id_base ] = $widget; 587 } 588 589 /** 590 * Registers the update callback for a widget. 591 * 592 * @since 2.8.0 593 * @since 5.3.0 Formalized the existing and already documented `...$params` parameter 594 * by adding it to the function signature. 595 * 596 * @global array $wp_registered_widget_updates The registered widget updates. 597 * 598 * @param string $id_base The base ID of a widget created by extending WP_Widget. 599 * @param callable $update_callback Update callback method for the widget. 600 * @param array $options Optional. Widget control options. See wp_register_widget_control(). 601 * Default empty array. 602 * @param mixed ...$params Optional additional parameters to pass to the callback function when it's called. 603 */ 604 function _register_widget_update_callback( $id_base, $update_callback, $options = array(), ...$params ) { 605 global $wp_registered_widget_updates; 606 607 if ( isset( $wp_registered_widget_updates[ $id_base ] ) ) { 608 if ( empty( $update_callback ) ) { 609 unset( $wp_registered_widget_updates[ $id_base ] ); 610 } 611 return; 612 } 613 614 $widget = array( 615 'callback' => $update_callback, 616 'params' => $params, 617 ); 618 619 $widget = array_merge( $widget, $options ); 620 $wp_registered_widget_updates[ $id_base ] = $widget; 621 } 622 623 /** 624 * Registers the form callback for a widget. 625 * 626 * @since 2.8.0 627 * @since 5.3.0 Formalized the existing and already documented `...$params` parameter 628 * by adding it to the function signature. 629 * 630 * @global array $wp_registered_widget_controls The registered widget controls. 631 * 632 * @param int|string $id Widget ID. 633 * @param string $name Name attribute for the widget. 634 * @param callable $form_callback Form callback. 635 * @param array $options Optional. Widget control options. See wp_register_widget_control(). 636 * Default empty array. 637 * @param mixed ...$params Optional additional parameters to pass to the callback function when it's called. 638 */ 639 640 function _register_widget_form_callback( $id, $name, $form_callback, $options = array(), ...$params ) { 641 global $wp_registered_widget_controls; 642 643 $id = strtolower( $id ); 644 645 if ( empty( $form_callback ) ) { 646 unset( $wp_registered_widget_controls[ $id ] ); 647 return; 648 } 649 650 if ( isset( $wp_registered_widget_controls[ $id ] ) && ! did_action( 'widgets_init' ) ) { 651 return; 652 } 653 654 $defaults = array( 655 'width' => 250, 656 'height' => 200, 657 ); 658 $options = wp_parse_args( $options, $defaults ); 659 $options['width'] = (int) $options['width']; 660 $options['height'] = (int) $options['height']; 661 662 $widget = array( 663 'name' => $name, 664 'id' => $id, 665 'callback' => $form_callback, 666 'params' => $params, 667 ); 668 $widget = array_merge( $widget, $options ); 669 670 $wp_registered_widget_controls[ $id ] = $widget; 671 } 672 673 /** 674 * Removes control callback for widget. 675 * 676 * @since 2.2.0 677 * 678 * @param int|string $id Widget ID. 679 */ 680 function wp_unregister_widget_control( $id ) { 681 wp_register_widget_control( $id, '', '' ); 682 } 683 684 /** 685 * Displays dynamic sidebar. 686 * 687 * By default this displays the default sidebar or 'sidebar-1'. If your theme specifies the 'id' or 688 * 'name' parameter for its registered sidebars you can pass an ID or name as the $index parameter. 689 * Otherwise, you can pass in a numerical index to display the sidebar at that index. 690 * 691 * @since 2.2.0 692 * 693 * @global array $wp_registered_sidebars The registered sidebars. 694 * @global array $wp_registered_widgets The registered widgets. 695 * 696 * @param int|string $index Optional. Index, name or ID of dynamic sidebar. Default 1. 697 * @return bool True, if widget sidebar was found and called. False if not found or not called. 698 */ 699 function dynamic_sidebar( $index = 1 ) { 700 global $wp_registered_sidebars, $wp_registered_widgets; 701 702 if ( is_int( $index ) ) { 703 $index = "sidebar-$index"; 704 } else { 705 $index = sanitize_title( $index ); 706 foreach ( (array) $wp_registered_sidebars as $key => $value ) { 707 if ( sanitize_title( $value['name'] ) === $index ) { 708 $index = $key; 709 break; 710 } 711 } 712 } 713 714 $sidebars_widgets = wp_get_sidebars_widgets(); 715 if ( empty( $wp_registered_sidebars[ $index ] ) || empty( $sidebars_widgets[ $index ] ) || ! is_array( $sidebars_widgets[ $index ] ) ) { 716 /** This action is documented in wp-includes/widgets.php */ 717 do_action( 'dynamic_sidebar_before', $index, false ); 718 /** This action is documented in wp-includes/widgets.php */ 719 do_action( 'dynamic_sidebar_after', $index, false ); 720 /** This filter is documented in wp-includes/widgets.php */ 721 return apply_filters( 'dynamic_sidebar_has_widgets', false, $index ); 722 } 723 724 $sidebar = $wp_registered_sidebars[ $index ]; 725 726 $sidebar['before_sidebar'] = sprintf( $sidebar['before_sidebar'], $sidebar['id'], $sidebar['class'] ); 727 728 /** 729 * Fires before widgets are rendered in a dynamic sidebar. 730 * 731 * Note: The action also fires for empty sidebars, and on both the front end 732 * and back end, including the Inactive Widgets sidebar on the Widgets screen. 733 * 734 * @since 3.9.0 735 * 736 * @param int|string $index Index, name, or ID of the dynamic sidebar. 737 * @param bool $has_widgets Whether the sidebar is populated with widgets. 738 * Default true. 739 */ 740 do_action( 'dynamic_sidebar_before', $index, true ); 741 742 if ( ! is_admin() && ! empty( $sidebar['before_sidebar'] ) ) { 743 echo $sidebar['before_sidebar']; 744 } 745 746 $did_one = false; 747 foreach ( (array) $sidebars_widgets[ $index ] as $id ) { 748 749 if ( ! isset( $wp_registered_widgets[ $id ] ) ) { 750 continue; 751 } 752 753 $params = array_merge( 754 array( 755 array_merge( 756 $sidebar, 757 array( 758 'widget_id' => $id, 759 'widget_name' => $wp_registered_widgets[ $id ]['name'], 760 ) 761 ), 762 ), 763 (array) $wp_registered_widgets[ $id ]['params'] 764 ); 765 766 // Substitute HTML `id` and `class` attributes into `before_widget`. 767 $classname_ = ''; 768 foreach ( (array) $wp_registered_widgets[ $id ]['classname'] as $cn ) { 769 if ( is_string( $cn ) ) { 770 $classname_ .= '_' . $cn; 771 } elseif ( is_object( $cn ) ) { 772 $classname_ .= '_' . get_class( $cn ); 773 } 774 } 775 $classname_ = ltrim( $classname_, '_' ); 776 777 $params[0]['before_widget'] = sprintf( 778 $params[0]['before_widget'], 779 str_replace( '\\', '_', $id ), 780 $classname_ 781 ); 782 783 /** 784 * Filters the parameters passed to a widget's display callback. 785 * 786 * Note: The filter is evaluated on both the front end and back end, 787 * including for the Inactive Widgets sidebar on the Widgets screen. 788 * 789 * @since 2.5.0 790 * 791 * @see register_sidebar() 792 * 793 * @param array $params { 794 * @type array $args { 795 * An array of widget display arguments. 796 * 797 * @type string $name Name of the sidebar the widget is assigned to. 798 * @type string $id ID of the sidebar the widget is assigned to. 799 * @type string $description The sidebar description. 800 * @type string $class CSS class applied to the sidebar container. 801 * @type string $before_widget HTML markup to prepend to each widget in the sidebar. 802 * @type string $after_widget HTML markup to append to each widget in the sidebar. 803 * @type string $before_title HTML markup to prepend to the widget title when displayed. 804 * @type string $after_title HTML markup to append to the widget title when displayed. 805 * @type string $widget_id ID of the widget. 806 * @type string $widget_name Name of the widget. 807 * } 808 * @type array $widget_args { 809 * An array of multi-widget arguments. 810 * 811 * @type int $number Number increment used for multiples of the same widget. 812 * } 813 * } 814 */ 815 $params = apply_filters( 'dynamic_sidebar_params', $params ); 816 817 $callback = $wp_registered_widgets[ $id ]['callback']; 818 819 /** 820 * Fires before a widget's display callback is called. 821 * 822 * Note: The action fires on both the front end and back end, including 823 * for widgets in the Inactive Widgets sidebar on the Widgets screen. 824 * 825 * The action is not fired for empty sidebars. 826 * 827 * @since 3.0.0 828 * 829 * @param array $widget { 830 * An associative array of widget arguments. 831 * 832 * @type string $name Name of the widget. 833 * @type string $id Widget ID. 834 * @type callable $callback When the hook is fired on the front end, `$callback` is an array 835 * containing the widget object. Fired on the back end, `$callback` 836 * is 'wp_widget_control', see `$_callback`. 837 * @type array $params An associative array of multi-widget arguments. 838 * @type string $classname CSS class applied to the widget container. 839 * @type string $description The widget description. 840 * @type array $_callback When the hook is fired on the back end, `$_callback` is populated 841 * with an array containing the widget object, see `$callback`. 842 * } 843 */ 844 do_action( 'dynamic_sidebar', $wp_registered_widgets[ $id ] ); 845 846 if ( is_callable( $callback ) ) { 847 call_user_func_array( $callback, $params ); 848 $did_one = true; 849 } 850 } 851 852 if ( ! is_admin() && ! empty( $sidebar['after_sidebar'] ) ) { 853 echo $sidebar['after_sidebar']; 854 } 855 856 /** 857 * Fires after widgets are rendered in a dynamic sidebar. 858 * 859 * Note: The action also fires for empty sidebars, and on both the front end 860 * and back end, including the Inactive Widgets sidebar on the Widgets screen. 861 * 862 * @since 3.9.0 863 * 864 * @param int|string $index Index, name, or ID of the dynamic sidebar. 865 * @param bool $has_widgets Whether the sidebar is populated with widgets. 866 * Default true. 867 */ 868 do_action( 'dynamic_sidebar_after', $index, true ); 869 870 /** 871 * Filters whether a sidebar has widgets. 872 * 873 * Note: The filter is also evaluated for empty sidebars, and on both the front end 874 * and back end, including the Inactive Widgets sidebar on the Widgets screen. 875 * 876 * @since 3.9.0 877 * 878 * @param bool $did_one Whether at least one widget was rendered in the sidebar. 879 * Default false. 880 * @param int|string $index Index, name, or ID of the dynamic sidebar. 881 */ 882 return apply_filters( 'dynamic_sidebar_has_widgets', $did_one, $index ); 883 } 884 885 /** 886 * Determines whether a given widget is displayed on the front end. 887 * 888 * Either $callback or $id_base can be used. 889 * $id_base is the first argument when extending WP_Widget class. 890 * Without the optional $widget_id parameter, returns the ID of the first sidebar 891 * in which the first instance of the widget with the given callback or $id_base is found. 892 * With the $widget_id parameter, returns the ID of the sidebar where 893 * the widget with that callback/$id_base AND that ID is found. 894 * 895 * NOTE: $widget_id and $id_base are the same for single widgets. To be effective 896 * this function has to run after widgets have initialized, at action {@see 'init'} or later. 897 * 898 * For more information on this and similar theme functions, check out 899 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 900 * Conditional Tags} article in the Theme Developer Handbook. 901 * 902 * @since 2.2.0 903 * 904 * @global array $wp_registered_widgets The registered widgets. 905 * 906 * @param callable|false $callback Optional. Widget callback to check. Default false. 907 * @param string|false $widget_id Optional. Widget ID. Optional, but needed for checking. 908 * Default false. 909 * @param string|false $id_base Optional. The base ID of a widget created by extending WP_Widget. 910 * Default false. 911 * @param bool $skip_inactive Optional. Whether to check in 'wp_inactive_widgets'. 912 * Default true. 913 * @return string|false ID of the sidebar in which the widget is active, 914 * false if the widget is not active. 915 */ 916 function is_active_widget( $callback = false, $widget_id = false, $id_base = false, $skip_inactive = true ) { 917 global $wp_registered_widgets; 918 919 $sidebars_widgets = wp_get_sidebars_widgets(); 920 921 if ( is_array( $sidebars_widgets ) ) { 922 foreach ( $sidebars_widgets as $sidebar => $widgets ) { 923 if ( $skip_inactive && ( 'wp_inactive_widgets' === $sidebar || str_starts_with( $sidebar, 'orphaned_widgets' ) ) ) { 924 continue; 925 } 926 927 if ( is_array( $widgets ) ) { 928 foreach ( $widgets as $widget ) { 929 if ( ( $callback && isset( $wp_registered_widgets[ $widget ]['callback'] ) && $wp_registered_widgets[ $widget ]['callback'] === $callback ) || ( $id_base && _get_widget_id_base( $widget ) === $id_base ) ) { 930 if ( ! $widget_id || ( isset( $wp_registered_widgets[ $widget ]['id'] ) && $widget_id === $wp_registered_widgets[ $widget ]['id'] ) ) { 931 return $sidebar; 932 } 933 } 934 } 935 } 936 } 937 } 938 return false; 939 } 940 941 /** 942 * Determines whether the dynamic sidebar is enabled and used by the theme. 943 * 944 * For more information on this and similar theme functions, check out 945 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 946 * Conditional Tags} article in the Theme Developer Handbook. 947 * 948 * @since 2.2.0 949 * 950 * @global array $wp_registered_widgets The registered widgets. 951 * @global array $wp_registered_sidebars The registered sidebars. 952 * 953 * @return bool True if using widgets, false otherwise. 954 */ 955 function is_dynamic_sidebar() { 956 global $wp_registered_widgets, $wp_registered_sidebars; 957 958 $sidebars_widgets = get_option( 'sidebars_widgets' ); 959 960 foreach ( (array) $wp_registered_sidebars as $index => $sidebar ) { 961 if ( ! empty( $sidebars_widgets[ $index ] ) ) { 962 foreach ( (array) $sidebars_widgets[ $index ] as $widget ) { 963 if ( array_key_exists( $widget, $wp_registered_widgets ) ) { 964 return true; 965 } 966 } 967 } 968 } 969 970 return false; 971 } 972 973 /** 974 * Determines whether a sidebar contains widgets. 975 * 976 * For more information on this and similar theme functions, check out 977 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 978 * Conditional Tags} article in the Theme Developer Handbook. 979 * 980 * @since 2.8.0 981 * 982 * @param string|int $index Sidebar name, id or number to check. 983 * @return bool True if the sidebar has widgets, false otherwise. 984 */ 985 function is_active_sidebar( $index ) { 986 $index = ( is_int( $index ) ) ? "sidebar-$index" : sanitize_title( $index ); 987 $sidebars_widgets = wp_get_sidebars_widgets(); 988 $is_active_sidebar = ! empty( $sidebars_widgets[ $index ] ); 989 990 /** 991 * Filters whether a dynamic sidebar is considered "active". 992 * 993 * @since 3.9.0 994 * 995 * @param bool $is_active_sidebar Whether or not the sidebar should be considered "active". 996 * In other words, whether the sidebar contains any widgets. 997 * @param int|string $index Index, name, or ID of the dynamic sidebar. 998 */ 999 return apply_filters( 'is_active_sidebar', $is_active_sidebar, $index ); 1000 } 1001 1002 // 1003 // Internal Functions. 1004 // 1005 1006 /** 1007 * Retrieves the full list of sidebars and their widget instance IDs. 1008 * 1009 * Will upgrade sidebar widget list, if needed. Will also save updated list, if 1010 * needed. 1011 * 1012 * @since 2.2.0 1013 * @access private 1014 * 1015 * @global array $_wp_sidebars_widgets 1016 * @global array $sidebars_widgets 1017 * 1018 * @param bool $deprecated Not used (argument deprecated). 1019 * @return array Upgraded list of widgets to version 3 array format when called from the admin. 1020 */ 1021 function wp_get_sidebars_widgets( $deprecated = true ) { 1022 if ( true !== $deprecated ) { 1023 _deprecated_argument( __FUNCTION__, '2.8.1' ); 1024 } 1025 1026 global $_wp_sidebars_widgets, $sidebars_widgets; 1027 1028 /* 1029 * If loading from front page, consult $_wp_sidebars_widgets rather than options 1030 * to see if wp_convert_widget_settings() has made manipulations in memory. 1031 */ 1032 if ( ! is_admin() ) { 1033 if ( empty( $_wp_sidebars_widgets ) ) { 1034 $_wp_sidebars_widgets = get_option( 'sidebars_widgets', array() ); 1035 } 1036 1037 $sidebars_widgets = $_wp_sidebars_widgets; 1038 } else { 1039 $sidebars_widgets = get_option( 'sidebars_widgets', array() ); 1040 } 1041 1042 if ( is_array( $sidebars_widgets ) && isset( $sidebars_widgets['array_version'] ) ) { 1043 unset( $sidebars_widgets['array_version'] ); 1044 } 1045 1046 /** 1047 * Filters the list of sidebars and their widgets. 1048 * 1049 * @since 2.7.0 1050 * 1051 * @param array $sidebars_widgets An associative array of sidebars and their widgets. 1052 */ 1053 return apply_filters( 'sidebars_widgets', $sidebars_widgets ); 1054 } 1055 1056 /** 1057 * Retrieves the registered sidebar with the given ID. 1058 * 1059 * @since 5.9.0 1060 * 1061 * @global array $wp_registered_sidebars The registered sidebars. 1062 * 1063 * @param string $id The sidebar ID. 1064 * @return array|null The discovered sidebar, or null if it is not registered. 1065 */ 1066 function wp_get_sidebar( $id ) { 1067 global $wp_registered_sidebars; 1068 1069 foreach ( (array) $wp_registered_sidebars as $sidebar ) { 1070 if ( $sidebar['id'] === $id ) { 1071 return $sidebar; 1072 } 1073 } 1074 1075 if ( 'wp_inactive_widgets' === $id ) { 1076 return array( 1077 'id' => 'wp_inactive_widgets', 1078 'name' => __( 'Inactive widgets' ), 1079 ); 1080 } 1081 1082 return null; 1083 } 1084 1085 /** 1086 * Sets the sidebar widget option to update sidebars. 1087 * 1088 * @since 2.2.0 1089 * @access private 1090 * 1091 * @global array $_wp_sidebars_widgets 1092 * @param array $sidebars_widgets Sidebar widgets and their settings. 1093 */ 1094 function wp_set_sidebars_widgets( $sidebars_widgets ) { 1095 global $_wp_sidebars_widgets; 1096 1097 // Clear cached value used in wp_get_sidebars_widgets(). 1098 $_wp_sidebars_widgets = null; 1099 1100 if ( ! isset( $sidebars_widgets['array_version'] ) ) { 1101 $sidebars_widgets['array_version'] = 3; 1102 } 1103 1104 update_option( 'sidebars_widgets', $sidebars_widgets ); 1105 } 1106 1107 /** 1108 * Retrieves default registered sidebars list. 1109 * 1110 * @since 2.2.0 1111 * @access private 1112 * 1113 * @global array $wp_registered_sidebars The registered sidebars. 1114 * 1115 * @return array 1116 */ 1117 function wp_get_widget_defaults() { 1118 global $wp_registered_sidebars; 1119 1120 $defaults = array(); 1121 1122 foreach ( (array) $wp_registered_sidebars as $index => $sidebar ) { 1123 $defaults[ $index ] = array(); 1124 } 1125 1126 return $defaults; 1127 } 1128 1129 /** 1130 * Converts the widget settings from single to multi-widget format. 1131 * 1132 * @since 2.8.0 1133 * 1134 * @global array $_wp_sidebars_widgets 1135 * 1136 * @param string $base_name Root ID for all widgets of this type. 1137 * @param string $option_name Option name for this widget type. 1138 * @param array $settings The array of widget instance settings. 1139 * @return array The array of widget settings converted to multi-widget format. 1140 */ 1141 function wp_convert_widget_settings( $base_name, $option_name, $settings ) { 1142 // This test may need expanding. 1143 $single = false; 1144 $changed = false; 1145 1146 if ( empty( $settings ) ) { 1147 $single = true; 1148 } else { 1149 foreach ( array_keys( $settings ) as $number ) { 1150 if ( 'number' === $number ) { 1151 continue; 1152 } 1153 if ( ! is_numeric( $number ) ) { 1154 $single = true; 1155 break; 1156 } 1157 } 1158 } 1159 1160 if ( $single ) { 1161 $settings = array( 2 => $settings ); 1162 1163 // If loading from the front page, update sidebar in memory but don't save to options. 1164 if ( is_admin() ) { 1165 $sidebars_widgets = get_option( 'sidebars_widgets' ); 1166 } else { 1167 if ( empty( $GLOBALS['_wp_sidebars_widgets'] ) ) { 1168 $GLOBALS['_wp_sidebars_widgets'] = get_option( 'sidebars_widgets', array() ); 1169 } 1170 $sidebars_widgets = &$GLOBALS['_wp_sidebars_widgets']; 1171 } 1172 1173 foreach ( (array) $sidebars_widgets as $index => $sidebar ) { 1174 if ( is_array( $sidebar ) ) { 1175 foreach ( $sidebar as $i => $name ) { 1176 if ( $base_name === $name ) { 1177 $sidebars_widgets[ $index ][ $i ] = "$name-2"; 1178 $changed = true; 1179 break 2; 1180 } 1181 } 1182 } 1183 } 1184 1185 if ( is_admin() && $changed ) { 1186 update_option( 'sidebars_widgets', $sidebars_widgets ); 1187 } 1188 } 1189 1190 $settings['_multiwidget'] = 1; 1191 if ( is_admin() ) { 1192 update_option( $option_name, $settings ); 1193 } 1194 1195 return $settings; 1196 } 1197 1198 /** 1199 * Outputs an arbitrary widget as a template tag. 1200 * 1201 * @since 2.8.0 1202 * 1203 * @global WP_Widget_Factory $wp_widget_factory 1204 * 1205 * @param string $widget The widget's PHP class name (see class-wp-widget.php). 1206 * @param array $instance Optional. The widget's instance settings. Default empty array. 1207 * @param array $args { 1208 * Optional. Array of arguments to configure the display of the widget. 1209 * 1210 * @type string $before_widget HTML content that will be prepended to the widget's HTML output. 1211 * Default `<div class="widget %s">`, where `%s` is the widget's class name. 1212 * @type string $after_widget HTML content that will be appended to the widget's HTML output. 1213 * Default `</div>`. 1214 * @type string $before_title HTML content that will be prepended to the widget's title when displayed. 1215 * Default `<h2 class="widgettitle">`. 1216 * @type string $after_title HTML content that will be appended to the widget's title when displayed. 1217 * Default `</h2>`. 1218 * } 1219 */ 1220 function the_widget( $widget, $instance = array(), $args = array() ) { 1221 global $wp_widget_factory; 1222 1223 if ( ! isset( $wp_widget_factory->widgets[ $widget ] ) ) { 1224 _doing_it_wrong( 1225 __FUNCTION__, 1226 sprintf( 1227 /* translators: %s: register_widget() */ 1228 __( 'Widgets need to be registered using %s, before they can be displayed.' ), 1229 '<code>register_widget()</code>' 1230 ), 1231 '4.9.0' 1232 ); 1233 return; 1234 } 1235 1236 $widget_obj = $wp_widget_factory->widgets[ $widget ]; 1237 if ( ! ( $widget_obj instanceof WP_Widget ) ) { 1238 return; 1239 } 1240 1241 $default_args = array( 1242 'before_widget' => '<div class="widget %s">', 1243 'after_widget' => '</div>', 1244 'before_title' => '<h2 class="widgettitle">', 1245 'after_title' => '</h2>', 1246 ); 1247 $args = wp_parse_args( $args, $default_args ); 1248 $args['before_widget'] = sprintf( $args['before_widget'], $widget_obj->widget_options['classname'] ); 1249 1250 $instance = wp_parse_args( $instance ); 1251 1252 /** This filter is documented in wp-includes/class-wp-widget.php */ 1253 $instance = apply_filters( 'widget_display_callback', $instance, $widget_obj, $args ); 1254 1255 if ( false === $instance ) { 1256 return; 1257 } 1258 1259 /** 1260 * Fires before rendering the requested widget. 1261 * 1262 * @since 3.0.0 1263 * 1264 * @param string $widget The widget's class name. 1265 * @param array $instance The current widget instance's settings. 1266 * @param array $args An array of the widget's sidebar arguments. 1267 */ 1268 do_action( 'the_widget', $widget, $instance, $args ); 1269 1270 $widget_obj->_set( -1 ); 1271 $widget_obj->widget( $args, $instance ); 1272 } 1273 1274 /** 1275 * Retrieves the widget ID base value. 1276 * 1277 * @since 2.8.0 1278 * 1279 * @param string $id Widget ID. 1280 * @return string Widget ID base. 1281 */ 1282 function _get_widget_id_base( $id ) { 1283 return preg_replace( '/-[0-9]+$/', '', $id ); 1284 } 1285 1286 /** 1287 * Handles sidebars config after theme change. 1288 * 1289 * @access private 1290 * @since 3.3.0 1291 * 1292 * @global array $sidebars_widgets 1293 */ 1294 function _wp_sidebars_changed() { 1295 global $sidebars_widgets; 1296 1297 if ( ! is_array( $sidebars_widgets ) ) { 1298 $sidebars_widgets = wp_get_sidebars_widgets(); 1299 } 1300 1301 retrieve_widgets( true ); 1302 } 1303 1304 /** 1305 * Validates and remaps any "orphaned" widgets to wp_inactive_widgets sidebar, 1306 * and saves the widget settings. This has to run at least on each theme change. 1307 * 1308 * For example, let's say theme A has a "footer" sidebar, and theme B doesn't have one. 1309 * After switching from theme A to theme B, all the widgets previously assigned 1310 * to the footer would be inaccessible. This function detects this scenario, and 1311 * moves all the widgets previously assigned to the footer under wp_inactive_widgets. 1312 * 1313 * Despite the word "retrieve" in the name, this function actually updates the database 1314 * and the global `$sidebars_widgets`. For that reason it should not be run on front end, 1315 * unless the `$theme_changed` value is 'customize' (to bypass the database write). 1316 * 1317 * @since 2.8.0 1318 * 1319 * @global array $wp_registered_sidebars The registered sidebars. 1320 * @global array $sidebars_widgets 1321 * @global array $wp_registered_widgets The registered widgets. 1322 * 1323 * @param string|bool $theme_changed Whether the theme was changed as a boolean. A value 1324 * of 'customize' defers updates for the Customizer. 1325 * @return array Updated sidebars widgets. 1326 */ 1327 function retrieve_widgets( $theme_changed = false ) { 1328 global $wp_registered_sidebars, $sidebars_widgets, $wp_registered_widgets; 1329 1330 $registered_sidebars_keys = array_keys( $wp_registered_sidebars ); 1331 $registered_widgets_ids = array_keys( $wp_registered_widgets ); 1332 1333 if ( ! is_array( get_theme_mod( 'sidebars_widgets' ) ) ) { 1334 if ( empty( $sidebars_widgets ) ) { 1335 return array(); 1336 } 1337 1338 unset( $sidebars_widgets['array_version'] ); 1339 1340 $sidebars_widgets_keys = array_keys( $sidebars_widgets ); 1341 sort( $sidebars_widgets_keys ); 1342 sort( $registered_sidebars_keys ); 1343 1344 if ( $sidebars_widgets_keys === $registered_sidebars_keys ) { 1345 $sidebars_widgets = _wp_remove_unregistered_widgets( $sidebars_widgets, $registered_widgets_ids ); 1346 1347 return $sidebars_widgets; 1348 } 1349 } 1350 1351 // Discard invalid, theme-specific widgets from sidebars. 1352 $sidebars_widgets = _wp_remove_unregistered_widgets( $sidebars_widgets, $registered_widgets_ids ); 1353 $sidebars_widgets = wp_map_sidebars_widgets( $sidebars_widgets ); 1354 1355 // Replace non-array values inside the array with an empty array. 1356 foreach ( $sidebars_widgets as $key => $value ) { 1357 if ( ! is_array( $value ) ) { 1358 $sidebars_widgets[ $key ] = array(); 1359 } 1360 } 1361 1362 // Find hidden/lost multi-widget instances. 1363 $shown_widgets = array_merge( ...array_values( $sidebars_widgets ) ); 1364 $lost_widgets = array_diff( $registered_widgets_ids, $shown_widgets ); 1365 1366 foreach ( $lost_widgets as $key => $widget_id ) { 1367 $number = preg_replace( '/.+?-([0-9]+)$/', '$1', $widget_id ); 1368 1369 // Only keep active and default widgets. 1370 if ( is_numeric( $number ) && (int) $number < 2 ) { 1371 unset( $lost_widgets[ $key ] ); 1372 } 1373 } 1374 $sidebars_widgets['wp_inactive_widgets'] = array_merge( $lost_widgets, (array) $sidebars_widgets['wp_inactive_widgets'] ); 1375 1376 if ( 'customize' !== $theme_changed ) { 1377 // Update the widgets settings in the database. 1378 wp_set_sidebars_widgets( $sidebars_widgets ); 1379 } 1380 1381 return $sidebars_widgets; 1382 } 1383 1384 /** 1385 * Compares a list of sidebars with their widgets against an allowed list. 1386 * 1387 * @since 4.9.0 1388 * @since 4.9.2 Always tries to restore widget assignments from previous data, not just if sidebars needed mapping. 1389 * 1390 * @global array $wp_registered_sidebars The registered sidebars. 1391 * 1392 * @param array $existing_sidebars_widgets List of sidebars and their widget instance IDs. 1393 * @return array Mapped sidebars widgets. 1394 */ 1395 function wp_map_sidebars_widgets( $existing_sidebars_widgets ) { 1396 global $wp_registered_sidebars; 1397 1398 $new_sidebars_widgets = array( 1399 'wp_inactive_widgets' => array(), 1400 ); 1401 1402 // Short-circuit if there are no sidebars to map. 1403 if ( ! is_array( $existing_sidebars_widgets ) || empty( $existing_sidebars_widgets ) ) { 1404 return $new_sidebars_widgets; 1405 } 1406 1407 foreach ( $existing_sidebars_widgets as $sidebar => $widgets ) { 1408 if ( 'wp_inactive_widgets' === $sidebar || str_starts_with( $sidebar, 'orphaned_widgets' ) ) { 1409 $new_sidebars_widgets['wp_inactive_widgets'] = array_merge( $new_sidebars_widgets['wp_inactive_widgets'], (array) $widgets ); 1410 unset( $existing_sidebars_widgets[ $sidebar ] ); 1411 } 1412 } 1413 1414 // If old and new theme have just one sidebar, map it and we're done. 1415 if ( 1 === count( $existing_sidebars_widgets ) && 1 === count( $wp_registered_sidebars ) ) { 1416 $new_sidebars_widgets[ key( $wp_registered_sidebars ) ] = array_pop( $existing_sidebars_widgets ); 1417 1418 return $new_sidebars_widgets; 1419 } 1420 1421 // Map locations with the same slug. 1422 $existing_sidebars = array_keys( $existing_sidebars_widgets ); 1423 1424 foreach ( $wp_registered_sidebars as $sidebar => $name ) { 1425 if ( in_array( $sidebar, $existing_sidebars, true ) ) { 1426 $new_sidebars_widgets[ $sidebar ] = $existing_sidebars_widgets[ $sidebar ]; 1427 unset( $existing_sidebars_widgets[ $sidebar ] ); 1428 } elseif ( ! array_key_exists( $sidebar, $new_sidebars_widgets ) ) { 1429 $new_sidebars_widgets[ $sidebar ] = array(); 1430 } 1431 } 1432 1433 // If there are more sidebars, try to map them. 1434 if ( ! empty( $existing_sidebars_widgets ) ) { 1435 1436 /* 1437 * If old and new theme both have sidebars that contain phrases 1438 * from within the same group, make an educated guess and map it. 1439 */ 1440 $common_slug_groups = array( 1441 array( 'sidebar', 'primary', 'main', 'right' ), 1442 array( 'second', 'left' ), 1443 array( 'sidebar-2', 'footer', 'bottom' ), 1444 array( 'header', 'top' ), 1445 ); 1446 1447 // Go through each group... 1448 foreach ( $common_slug_groups as $slug_group ) { 1449 1450 // ...and see if any of these slugs... 1451 foreach ( $slug_group as $slug ) { 1452 1453 // ...and any of the new sidebars... 1454 foreach ( $wp_registered_sidebars as $new_sidebar => $args ) { 1455 1456 // ...actually match! 1457 if ( false === stripos( $new_sidebar, $slug ) && false === stripos( $slug, $new_sidebar ) ) { 1458 continue; 1459 } 1460 1461 // Then see if any of the existing sidebars... 1462 foreach ( $existing_sidebars_widgets as $sidebar => $widgets ) { 1463 1464 // ...and any slug in the same group... 1465 foreach ( $slug_group as $slug ) { 1466 1467 // ... have a match as well. 1468 if ( false === stripos( $sidebar, $slug ) && false === stripos( $slug, $sidebar ) ) { 1469 continue; 1470 } 1471 1472 // Make sure this sidebar wasn't mapped and removed previously. 1473 if ( ! empty( $existing_sidebars_widgets[ $sidebar ] ) ) { 1474 1475 // We have a match that can be mapped! 1476 $new_sidebars_widgets[ $new_sidebar ] = array_merge( $new_sidebars_widgets[ $new_sidebar ], $existing_sidebars_widgets[ $sidebar ] ); 1477 1478 // Remove the mapped sidebar so it can't be mapped again. 1479 unset( $existing_sidebars_widgets[ $sidebar ] ); 1480 1481 // Go back and check the next new sidebar. 1482 continue 3; 1483 } 1484 } // End foreach ( $slug_group as $slug ). 1485 } // End foreach ( $existing_sidebars_widgets as $sidebar => $widgets ). 1486 } // End foreach ( $wp_registered_sidebars as $new_sidebar => $args ). 1487 } // End foreach ( $slug_group as $slug ). 1488 } // End foreach ( $common_slug_groups as $slug_group ). 1489 } 1490 1491 // Move any left over widgets to inactive sidebar. 1492 foreach ( $existing_sidebars_widgets as $widgets ) { 1493 if ( is_array( $widgets ) && ! empty( $widgets ) ) { 1494 $new_sidebars_widgets['wp_inactive_widgets'] = array_merge( $new_sidebars_widgets['wp_inactive_widgets'], $widgets ); 1495 } 1496 } 1497 1498 // Sidebars_widgets settings from when this theme was previously active. 1499 $old_sidebars_widgets = get_theme_mod( 'sidebars_widgets' ); 1500 $old_sidebars_widgets = $old_sidebars_widgets['data'] ?? false; 1501 1502 if ( is_array( $old_sidebars_widgets ) ) { 1503 1504 // Remove empty sidebars, no need to map those. 1505 $old_sidebars_widgets = array_filter( $old_sidebars_widgets ); 1506 1507 // Only check sidebars that are empty or have not been mapped to yet. 1508 foreach ( $new_sidebars_widgets as $new_sidebar => $new_widgets ) { 1509 if ( array_key_exists( $new_sidebar, $old_sidebars_widgets ) && ! empty( $new_widgets ) ) { 1510 unset( $old_sidebars_widgets[ $new_sidebar ] ); 1511 } 1512 } 1513 1514 // Remove orphaned widgets, we're only interested in previously active sidebars. 1515 foreach ( $old_sidebars_widgets as $sidebar => $widgets ) { 1516 if ( str_starts_with( $sidebar, 'orphaned_widgets' ) ) { 1517 unset( $old_sidebars_widgets[ $sidebar ] ); 1518 } 1519 } 1520 1521 $old_sidebars_widgets = _wp_remove_unregistered_widgets( $old_sidebars_widgets ); 1522 1523 // Replace non-array values inside the array with an empty array. 1524 foreach ( $new_sidebars_widgets as $key => $value ) { 1525 if ( ! is_array( $value ) ) { 1526 $new_sidebars_widgets[ $key ] = array(); 1527 } 1528 } 1529 1530 if ( ! empty( $old_sidebars_widgets ) ) { 1531 1532 // Go through each remaining sidebar... 1533 foreach ( $old_sidebars_widgets as $old_sidebar => $old_widgets ) { 1534 1535 // ...and check every new sidebar... 1536 foreach ( $new_sidebars_widgets as $new_sidebar => $new_widgets ) { 1537 1538 // ...for every widget we're trying to revive. 1539 foreach ( $old_widgets as $key => $widget_id ) { 1540 $active_key = array_search( $widget_id, $new_widgets, true ); 1541 1542 // If the widget is used elsewhere... 1543 if ( false !== $active_key ) { 1544 1545 // ...and that elsewhere is inactive widgets... 1546 if ( 'wp_inactive_widgets' === $new_sidebar ) { 1547 1548 // ...remove it from there and keep the active version... 1549 unset( $new_sidebars_widgets['wp_inactive_widgets'][ $active_key ] ); 1550 } else { 1551 1552 // ...otherwise remove it from the old sidebar and keep it in the new one. 1553 unset( $old_sidebars_widgets[ $old_sidebar ][ $key ] ); 1554 } 1555 } // End if ( $active_key ). 1556 } // End foreach ( $old_widgets as $key => $widget_id ). 1557 } // End foreach ( $new_sidebars_widgets as $new_sidebar => $new_widgets ). 1558 } // End foreach ( $old_sidebars_widgets as $old_sidebar => $old_widgets ). 1559 } // End if ( ! empty( $old_sidebars_widgets ) ). 1560 1561 // Restore widget settings from when theme was previously active. 1562 $new_sidebars_widgets = array_merge( $new_sidebars_widgets, $old_sidebars_widgets ); 1563 } 1564 1565 return $new_sidebars_widgets; 1566 } 1567 1568 /** 1569 * Compares a list of sidebars with their widgets against an allowed list. 1570 * 1571 * @since 4.9.0 1572 * 1573 * @global array $wp_registered_widgets The registered widgets. 1574 * 1575 * @param array $sidebars_widgets List of sidebars and their widget instance IDs. 1576 * @param array $allowed_widget_ids Optional. List of widget IDs to compare against. Default: Registered widgets. 1577 * @return array Sidebars with allowed widgets. 1578 */ 1579 function _wp_remove_unregistered_widgets( $sidebars_widgets, $allowed_widget_ids = array() ) { 1580 if ( empty( $allowed_widget_ids ) ) { 1581 $allowed_widget_ids = array_keys( $GLOBALS['wp_registered_widgets'] ); 1582 } 1583 1584 foreach ( $sidebars_widgets as $sidebar => $widgets ) { 1585 if ( is_array( $widgets ) ) { 1586 $sidebars_widgets[ $sidebar ] = array_intersect( $widgets, $allowed_widget_ids ); 1587 } 1588 } 1589 1590 return $sidebars_widgets; 1591 } 1592 1593 /** 1594 * Displays the RSS entries in a list. 1595 * 1596 * @since 2.5.0 1597 * 1598 * @param string|array|object $rss RSS url. 1599 * @param array $args Widget arguments. 1600 */ 1601 function wp_widget_rss_output( $rss, $args = array() ) { 1602 if ( is_string( $rss ) ) { 1603 $rss = fetch_feed( $rss ); 1604 } elseif ( is_array( $rss ) && isset( $rss['url'] ) ) { 1605 $args = $rss; 1606 $rss = fetch_feed( $rss['url'] ); 1607 } elseif ( ! is_object( $rss ) ) { 1608 return; 1609 } 1610 1611 if ( is_wp_error( $rss ) ) { 1612 if ( is_admin() || current_user_can( 'manage_options' ) ) { 1613 echo '<p><strong>' . __( 'RSS Error:' ) . '</strong> ' . esc_html( $rss->get_error_message() ) . '</p>'; 1614 } 1615 return; 1616 } 1617 1618 $default_args = array( 1619 'show_author' => 0, 1620 'show_date' => 0, 1621 'show_summary' => 0, 1622 'items' => 0, 1623 ); 1624 $args = wp_parse_args( $args, $default_args ); 1625 1626 $items = (int) $args['items']; 1627 if ( $items < 1 || 20 < $items ) { 1628 $items = 10; 1629 } 1630 $show_summary = (int) $args['show_summary']; 1631 $show_author = (int) $args['show_author']; 1632 $show_date = (int) $args['show_date']; 1633 1634 if ( ! $rss->get_item_quantity() ) { 1635 echo '<ul><li>' . __( 'An error has occurred, which probably means the feed is down. Try again later.' ) . '</li></ul>'; 1636 $rss->__destruct(); 1637 unset( $rss ); 1638 return; 1639 } 1640 1641 echo '<ul>'; 1642 foreach ( $rss->get_items( 0, $items ) as $item ) { 1643 $link = $item->get_link(); 1644 while ( ! empty( $link ) && stristr( $link, 'http' ) !== $link ) { 1645 $link = substr( $link, 1 ); 1646 } 1647 $link = esc_url( strip_tags( $link ) ); 1648 1649 $title = esc_html( trim( strip_tags( $item->get_title() ) ) ); 1650 if ( empty( $title ) ) { 1651 $title = __( 'Untitled' ); 1652 } 1653 1654 $desc = html_entity_decode( $item->get_description(), ENT_QUOTES, get_option( 'blog_charset' ) ); 1655 $desc = esc_attr( wp_trim_words( $desc, 55, ' […]' ) ); 1656 1657 $summary = ''; 1658 if ( $show_summary ) { 1659 $summary = $desc; 1660 1661 // Change existing [...] to […]. 1662 if ( str_ends_with( $summary, '[...]' ) ) { 1663 $summary = substr( $summary, 0, -5 ) . '[…]'; 1664 } 1665 1666 $summary = '<div class="rssSummary">' . esc_html( $summary ) . '</div>'; 1667 } 1668 1669 $date = ''; 1670 if ( $show_date ) { 1671 $date = $item->get_date( 'U' ); 1672 1673 if ( $date ) { 1674 $date = ' <span class="rss-date">' . date_i18n( get_option( 'date_format' ), $date ) . '</span>'; 1675 } 1676 } 1677 1678 $author = ''; 1679 if ( $show_author ) { 1680 $author = $item->get_author(); 1681 if ( is_object( $author ) ) { 1682 $author = $author->get_name(); 1683 $author = ' <cite>' . esc_html( strip_tags( $author ) ) . '</cite>'; 1684 } 1685 } 1686 1687 if ( '' === $link ) { 1688 echo "<li>$title{$date}{$summary}{$author}</li>"; 1689 } elseif ( $show_summary ) { 1690 echo "<li><a class='rsswidget' href='$link'>$title</a>{$date}{$summary}{$author}</li>"; 1691 } else { 1692 echo "<li><a class='rsswidget' href='$link'>$title</a>{$date}{$author}</li>"; 1693 } 1694 } 1695 echo '</ul>'; 1696 $rss->__destruct(); 1697 unset( $rss ); 1698 } 1699 1700 /** 1701 * Displays RSS widget options form. 1702 * 1703 * The options for what fields are displayed for the RSS form are all booleans 1704 * and are as follows: 'url', 'title', 'items', 'show_summary', 'show_author', 1705 * 'show_date'. 1706 * 1707 * @since 2.5.0 1708 * 1709 * @param array|string $args Values for input fields. 1710 * @param array $inputs Override default display options. 1711 */ 1712 function wp_widget_rss_form( $args, $inputs = null ) { 1713 $default_inputs = array( 1714 'url' => true, 1715 'title' => true, 1716 'items' => true, 1717 'show_summary' => true, 1718 'show_author' => true, 1719 'show_date' => true, 1720 ); 1721 $inputs = wp_parse_args( $inputs, $default_inputs ); 1722 1723 $args['title'] = $args['title'] ?? ''; 1724 $args['url'] = $args['url'] ?? ''; 1725 $args['items'] = (int) ( $args['items'] ?? 0 ); 1726 1727 if ( $args['items'] < 1 || 20 < $args['items'] ) { 1728 $args['items'] = 10; 1729 } 1730 1731 $args['show_summary'] = (int) ( $args['show_summary'] ?? $inputs['show_summary'] ); 1732 $args['show_author'] = (int) ( $args['show_author'] ?? $inputs['show_author'] ); 1733 $args['show_date'] = (int) ( $args['show_date'] ?? $inputs['show_date'] ); 1734 1735 if ( ! empty( $args['error'] ) ) { 1736 echo '<p class="widget-error"><strong>' . __( 'RSS Error:' ) . '</strong> ' . esc_html( $args['error'] ) . '</p>'; 1737 } 1738 1739 $esc_number = esc_attr( $args['number'] ); 1740 if ( $inputs['url'] ) : 1741 ?> 1742 <p><label for="rss-url-<?php echo $esc_number; ?>"><?php _e( 'Enter the RSS feed URL here:' ); ?></label> 1743 <input class="widefat" id="rss-url-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][url]" type="text" value="<?php echo esc_url( $args['url'] ); ?>" /></p> 1744 <?php endif; if ( $inputs['title'] ) : ?> 1745 <p><label for="rss-title-<?php echo $esc_number; ?>"><?php _e( 'Give the feed a title (optional):' ); ?></label> 1746 <input class="widefat" id="rss-title-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][title]" type="text" value="<?php echo esc_attr( $args['title'] ); ?>" /></p> 1747 <?php endif; if ( $inputs['items'] ) : ?> 1748 <p><label for="rss-items-<?php echo $esc_number; ?>"><?php _e( 'How many items would you like to display?' ); ?></label> 1749 <select id="rss-items-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][items]"> 1750 <?php 1751 for ( $i = 1; $i <= 20; ++$i ) { 1752 echo "<option value='$i' " . selected( $args['items'], $i, false ) . ">$i</option>"; 1753 } 1754 ?> 1755 </select></p> 1756 <?php endif; if ( $inputs['show_summary'] || $inputs['show_author'] || $inputs['show_date'] ) : ?> 1757 <p> 1758 <?php if ( $inputs['show_summary'] ) : ?> 1759 <input id="rss-show-summary-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][show_summary]" type="checkbox" value="1" <?php checked( $args['show_summary'] ); ?> /> 1760 <label for="rss-show-summary-<?php echo $esc_number; ?>"><?php _e( 'Display item content?' ); ?></label><br /> 1761 <?php endif; if ( $inputs['show_author'] ) : ?> 1762 <input id="rss-show-author-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][show_author]" type="checkbox" value="1" <?php checked( $args['show_author'] ); ?> /> 1763 <label for="rss-show-author-<?php echo $esc_number; ?>"><?php _e( 'Display item author if available?' ); ?></label><br /> 1764 <?php endif; if ( $inputs['show_date'] ) : ?> 1765 <input id="rss-show-date-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][show_date]" type="checkbox" value="1" <?php checked( $args['show_date'] ); ?> /> 1766 <label for="rss-show-date-<?php echo $esc_number; ?>"><?php _e( 'Display item date?' ); ?></label><br /> 1767 <?php endif; ?> 1768 </p> 1769 <?php 1770 endif; // End of display options. 1771 foreach ( array_keys( $default_inputs ) as $input ) : 1772 if ( 'hidden' === $inputs[ $input ] ) : 1773 $id = str_replace( '_', '-', $input ); 1774 ?> 1775 <input type="hidden" id="rss-<?php echo esc_attr( $id ); ?>-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][<?php echo esc_attr( $input ); ?>]" value="<?php echo esc_attr( $args[ $input ] ); ?>" /> 1776 <?php 1777 endif; 1778 endforeach; 1779 } 1780 1781 /** 1782 * Processes RSS feed widget data and optionally retrieve feed items. 1783 * 1784 * The feed widget can not have more than 20 items or it will reset back to the 1785 * default, which is 10. 1786 * 1787 * The resulting array has the feed title, feed url, feed link (from channel), 1788 * feed items, error (if any), and whether to show summary, author, and date. 1789 * All respectively in the order of the array elements. 1790 * 1791 * @since 2.5.0 1792 * 1793 * @param array $widget_rss RSS widget feed data. Expects unescaped data. 1794 * @param bool $check_feed Optional. Whether to check feed for errors. Default true. 1795 * @return array 1796 */ 1797 function wp_widget_rss_process( $widget_rss, $check_feed = true ) { 1798 $items = (int) $widget_rss['items']; 1799 if ( $items < 1 || 20 < $items ) { 1800 $items = 10; 1801 } 1802 $url = sanitize_url( strip_tags( $widget_rss['url'] ) ); 1803 $title = trim( strip_tags( $widget_rss['title'] ?? '' ) ); 1804 $show_summary = (int) ( $widget_rss['show_summary'] ?? 0 ); 1805 $show_author = (int) ( $widget_rss['show_author'] ?? 0 ); 1806 $show_date = (int) ( $widget_rss['show_date'] ?? 0 ); 1807 $error = false; 1808 $link = ''; 1809 1810 if ( $check_feed ) { 1811 $rss = fetch_feed( $url ); 1812 1813 if ( is_wp_error( $rss ) ) { 1814 $error = $rss->get_error_message(); 1815 } else { 1816 $link = esc_url( strip_tags( $rss->get_permalink() ) ); 1817 while ( stristr( $link, 'http' ) !== $link ) { 1818 $link = substr( $link, 1 ); 1819 } 1820 1821 $rss->__destruct(); 1822 unset( $rss ); 1823 } 1824 } 1825 1826 return compact( 'title', 'url', 'link', 'items', 'error', 'show_summary', 'show_author', 'show_date' ); 1827 } 1828 1829 /** 1830 * Registers all of the default WordPress widgets on startup. 1831 * 1832 * Calls {@see 'widgets_init'} action after all of the WordPress widgets have been registered. 1833 * 1834 * @since 2.2.0 1835 */ 1836 function wp_widgets_init() { 1837 if ( ! is_blog_installed() ) { 1838 return; 1839 } 1840 1841 register_widget( 'WP_Widget_Pages' ); 1842 1843 register_widget( 'WP_Widget_Calendar' ); 1844 1845 register_widget( 'WP_Widget_Archives' ); 1846 1847 if ( get_option( 'link_manager_enabled' ) ) { 1848 register_widget( 'WP_Widget_Links' ); 1849 } 1850 1851 register_widget( 'WP_Widget_Media_Audio' ); 1852 1853 register_widget( 'WP_Widget_Media_Image' ); 1854 1855 register_widget( 'WP_Widget_Media_Gallery' ); 1856 1857 register_widget( 'WP_Widget_Media_Video' ); 1858 1859 register_widget( 'WP_Widget_Meta' ); 1860 1861 register_widget( 'WP_Widget_Search' ); 1862 1863 register_widget( 'WP_Widget_Text' ); 1864 1865 register_widget( 'WP_Widget_Categories' ); 1866 1867 register_widget( 'WP_Widget_Recent_Posts' ); 1868 1869 register_widget( 'WP_Widget_Recent_Comments' ); 1870 1871 register_widget( 'WP_Widget_RSS' ); 1872 1873 register_widget( 'WP_Widget_Tag_Cloud' ); 1874 1875 register_widget( 'WP_Nav_Menu_Widget' ); 1876 1877 register_widget( 'WP_Widget_Custom_HTML' ); 1878 1879 register_widget( 'WP_Widget_Block' ); 1880 1881 /** 1882 * Fires after all default WordPress widgets have been registered. 1883 * 1884 * @since 2.2.0 1885 */ 1886 do_action( 'widgets_init' ); 1887 } 1888 1889 /** 1890 * Enables the widgets block editor. This is hooked into 'after_setup_theme' so 1891 * that the block editor is enabled by default but can be disabled by themes. 1892 * 1893 * @since 5.8.0 1894 * 1895 * @access private 1896 */ 1897 function wp_setup_widgets_block_editor() { 1898 add_theme_support( 'widgets-block-editor' ); 1899 } 1900 1901 /** 1902 * Determines whether or not to use the block editor to manage widgets. 1903 * Defaults to true unless a theme has removed support for widgets-block-editor 1904 * or a plugin has filtered the return value of this function. 1905 * 1906 * @since 5.8.0 1907 * 1908 * @return bool Whether to use the block editor to manage widgets. 1909 */ 1910 function wp_use_widgets_block_editor() { 1911 /** 1912 * Filters whether to use the block editor to manage widgets. 1913 * 1914 * @since 5.8.0 1915 * 1916 * @param bool $use_widgets_block_editor Whether to use the block editor to manage widgets. 1917 */ 1918 return apply_filters( 1919 'use_widgets_block_editor', 1920 get_theme_support( 'widgets-block-editor' ) 1921 ); 1922 } 1923 1924 /** 1925 * Converts a widget ID into its id_base and number components. 1926 * 1927 * @since 5.8.0 1928 * 1929 * @param string $id Widget ID. 1930 * @return array Array containing a widget's id_base and number components. 1931 */ 1932 function wp_parse_widget_id( $id ) { 1933 $parsed = array(); 1934 1935 if ( preg_match( '/^(.+)-(\d+)$/', $id, $matches ) ) { 1936 $parsed['id_base'] = $matches[1]; 1937 $parsed['number'] = (int) $matches[2]; 1938 } else { 1939 // Likely an old single widget. 1940 $parsed['id_base'] = $id; 1941 } 1942 1943 return $parsed; 1944 } 1945 1946 /** 1947 * Finds the sidebar that a given widget belongs to. 1948 * 1949 * @since 5.8.0 1950 * 1951 * @param string $widget_id The widget ID to look for. 1952 * @return string|null The found sidebar's ID, or null if it was not found. 1953 */ 1954 function wp_find_widgets_sidebar( $widget_id ) { 1955 foreach ( wp_get_sidebars_widgets() as $sidebar_id => $widget_ids ) { 1956 foreach ( $widget_ids as $maybe_widget_id ) { 1957 if ( $maybe_widget_id === $widget_id ) { 1958 return (string) $sidebar_id; 1959 } 1960 } 1961 } 1962 1963 return null; 1964 } 1965 1966 /** 1967 * Assigns a widget to the given sidebar. 1968 * 1969 * @since 5.8.0 1970 * 1971 * @param string $widget_id The widget ID to assign. 1972 * @param string $sidebar_id The sidebar ID to assign to. If empty, the widget won't be added to any sidebar. 1973 */ 1974 function wp_assign_widget_to_sidebar( $widget_id, $sidebar_id ) { 1975 $sidebars = wp_get_sidebars_widgets(); 1976 1977 foreach ( $sidebars as $maybe_sidebar_id => $widgets ) { 1978 foreach ( $widgets as $i => $maybe_widget_id ) { 1979 if ( $widget_id === $maybe_widget_id && $sidebar_id !== $maybe_sidebar_id ) { 1980 unset( $sidebars[ $maybe_sidebar_id ][ $i ] ); 1981 // We could technically break 2 here, but continue looping in case the ID is duplicated. 1982 continue 2; 1983 } 1984 } 1985 } 1986 1987 if ( $sidebar_id ) { 1988 $sidebars[ $sidebar_id ][] = $widget_id; 1989 } 1990 1991 wp_set_sidebars_widgets( $sidebars ); 1992 } 1993 1994 /** 1995 * Calls the render callback of a widget and returns the output. 1996 * 1997 * @since 5.8.0 1998 * 1999 * @global array $wp_registered_widgets The registered widgets. 2000 * @global array $wp_registered_sidebars The registered sidebars. 2001 * 2002 * @param string $widget_id Widget ID. 2003 * @param string $sidebar_id Sidebar ID. 2004 * @return string 2005 */ 2006 function wp_render_widget( $widget_id, $sidebar_id ) { 2007 global $wp_registered_widgets, $wp_registered_sidebars; 2008 2009 if ( ! isset( $wp_registered_widgets[ $widget_id ] ) ) { 2010 return ''; 2011 } 2012 2013 if ( isset( $wp_registered_sidebars[ $sidebar_id ] ) ) { 2014 $sidebar = $wp_registered_sidebars[ $sidebar_id ]; 2015 } elseif ( 'wp_inactive_widgets' === $sidebar_id ) { 2016 $sidebar = array(); 2017 } else { 2018 return ''; 2019 } 2020 2021 $params = array_merge( 2022 array( 2023 array_merge( 2024 $sidebar, 2025 array( 2026 'widget_id' => $widget_id, 2027 'widget_name' => $wp_registered_widgets[ $widget_id ]['name'], 2028 ) 2029 ), 2030 ), 2031 (array) $wp_registered_widgets[ $widget_id ]['params'] 2032 ); 2033 2034 // Substitute HTML `id` and `class` attributes into `before_widget`. 2035 $classname_ = ''; 2036 foreach ( (array) $wp_registered_widgets[ $widget_id ]['classname'] as $cn ) { 2037 if ( is_string( $cn ) ) { 2038 $classname_ .= '_' . $cn; 2039 } elseif ( is_object( $cn ) ) { 2040 $classname_ .= '_' . get_class( $cn ); 2041 } 2042 } 2043 $classname_ = ltrim( $classname_, '_' ); 2044 $params[0]['before_widget'] = sprintf( $params[0]['before_widget'], $widget_id, $classname_ ); 2045 2046 /** This filter is documented in wp-includes/widgets.php */ 2047 $params = apply_filters( 'dynamic_sidebar_params', $params ); 2048 2049 $callback = $wp_registered_widgets[ $widget_id ]['callback']; 2050 2051 ob_start(); 2052 2053 /** This filter is documented in wp-includes/widgets.php */ 2054 do_action( 'dynamic_sidebar', $wp_registered_widgets[ $widget_id ] ); 2055 2056 if ( is_callable( $callback ) ) { 2057 call_user_func_array( $callback, $params ); 2058 } 2059 2060 return ob_get_clean(); 2061 } 2062 2063 /** 2064 * Calls the control callback of a widget and returns the output. 2065 * 2066 * @since 5.8.0 2067 * 2068 * @global array $wp_registered_widget_controls The registered widget controls. 2069 * 2070 * @param string $id Widget ID. 2071 * @return string|null 2072 */ 2073 function wp_render_widget_control( $id ) { 2074 global $wp_registered_widget_controls; 2075 2076 if ( ! isset( $wp_registered_widget_controls[ $id ]['callback'] ) ) { 2077 return null; 2078 } 2079 2080 $callback = $wp_registered_widget_controls[ $id ]['callback']; 2081 $params = $wp_registered_widget_controls[ $id ]['params']; 2082 2083 ob_start(); 2084 2085 if ( is_callable( $callback ) ) { 2086 call_user_func_array( $callback, $params ); 2087 } 2088 2089 return ob_get_clean(); 2090 } 2091 2092 /** 2093 * Displays a _doing_it_wrong() message for conflicting widget editor scripts. 2094 * 2095 * The 'wp-editor' script module is exposed as window.wp.editor. This overrides 2096 * the legacy TinyMCE editor module which is required by the widgets editor. 2097 * Because of that conflict, these two shouldn't be enqueued together. 2098 * See https://core.trac.wordpress.org/ticket/53569. 2099 * 2100 * There is also another conflict related to styles where the block widgets 2101 * editor is hidden if a block enqueues 'wp-edit-post' stylesheet. 2102 * See https://core.trac.wordpress.org/ticket/53569. 2103 * 2104 * @since 5.8.0 2105 * @access private 2106 * 2107 * @global WP_Scripts $wp_scripts 2108 * @global WP_Styles $wp_styles 2109 */ 2110 function wp_check_widget_editor_deps() { 2111 global $wp_scripts, $wp_styles; 2112 2113 if ( 2114 $wp_scripts->query( 'wp-edit-widgets', 'enqueued' ) || 2115 $wp_scripts->query( 'wp-customize-widgets', 'enqueued' ) 2116 ) { 2117 if ( $wp_scripts->query( 'wp-editor', 'enqueued' ) ) { 2118 _doing_it_wrong( 2119 'wp_enqueue_script()', 2120 sprintf( 2121 /* translators: 1: 'wp-editor', 2: 'wp-edit-widgets', 3: 'wp-customize-widgets'. */ 2122 __( '"%1$s" script should not be enqueued together with the new widgets editor (%2$s or %3$s).' ), 2123 'wp-editor', 2124 'wp-edit-widgets', 2125 'wp-customize-widgets' 2126 ), 2127 '5.8.0' 2128 ); 2129 } 2130 if ( $wp_styles->query( 'wp-edit-post', 'enqueued' ) ) { 2131 _doing_it_wrong( 2132 'wp_enqueue_style()', 2133 sprintf( 2134 /* translators: 1: 'wp-edit-post', 2: 'wp-edit-widgets', 3: 'wp-customize-widgets'. */ 2135 __( '"%1$s" style should not be enqueued together with the new widgets editor (%2$s or %3$s).' ), 2136 'wp-edit-post', 2137 'wp-edit-widgets', 2138 'wp-customize-widgets' 2139 ), 2140 '5.8.0' 2141 ); 2142 } 2143 } 2144 } 2145 2146 /** 2147 * Registers the previous theme's sidebars for the block themes. 2148 * 2149 * @since 6.2.0 2150 * @access private 2151 * 2152 * @global array $wp_registered_sidebars The registered sidebars. 2153 */ 2154 function _wp_block_theme_register_classic_sidebars() { 2155 global $wp_registered_sidebars; 2156 2157 if ( ! wp_is_block_theme() ) { 2158 return; 2159 } 2160 2161 $classic_sidebars = get_theme_mod( 'wp_classic_sidebars' ); 2162 if ( empty( $classic_sidebars ) ) { 2163 return; 2164 } 2165 2166 // Don't use `register_sidebar` since it will enable the `widgets` support for a theme. 2167 foreach ( $classic_sidebars as $sidebar ) { 2168 $wp_registered_sidebars[ $sidebar['id'] ] = $sidebar; 2169 } 2170 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Sun Jun 14 08:20:09 2026 | Cross-referenced by PHPXref |