| [ 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 function _register_widget_form_callback( $id, $name, $form_callback, $options = array(), ...$params ) { 640 global $wp_registered_widget_controls; 641 642 $id = strtolower( $id ); 643 644 if ( empty( $form_callback ) ) { 645 unset( $wp_registered_widget_controls[ $id ] ); 646 return; 647 } 648 649 if ( isset( $wp_registered_widget_controls[ $id ] ) && ! did_action( 'widgets_init' ) ) { 650 return; 651 } 652 653 $defaults = array( 654 'width' => 250, 655 'height' => 200, 656 ); 657 $options = wp_parse_args( $options, $defaults ); 658 $options['width'] = (int) $options['width']; 659 $options['height'] = (int) $options['height']; 660 661 $widget = array( 662 'name' => $name, 663 'id' => $id, 664 'callback' => $form_callback, 665 'params' => $params, 666 ); 667 $widget = array_merge( $widget, $options ); 668 669 $wp_registered_widget_controls[ $id ] = $widget; 670 } 671 672 /** 673 * Removes control callback for widget. 674 * 675 * @since 2.2.0 676 * 677 * @param int|string $id Widget ID. 678 */ 679 function wp_unregister_widget_control( $id ) { 680 wp_register_widget_control( $id, '', '' ); 681 } 682 683 /** 684 * Displays dynamic sidebar. 685 * 686 * By default this displays the default sidebar or 'sidebar-1'. If your theme specifies the 'id' or 687 * 'name' parameter for its registered sidebars you can pass an ID or name as the $index parameter. 688 * Otherwise, you can pass in a numerical index to display the sidebar at that index. 689 * 690 * @since 2.2.0 691 * 692 * @global array $wp_registered_sidebars The registered sidebars. 693 * @global array $wp_registered_widgets The registered widgets. 694 * 695 * @param int|string $index Optional. Index, name or ID of dynamic sidebar. Default 1. 696 * @return bool True, if widget sidebar was found and called. False if not found or not called. 697 */ 698 function dynamic_sidebar( $index = 1 ) { 699 global $wp_registered_sidebars, $wp_registered_widgets; 700 701 if ( is_int( $index ) ) { 702 $index = "sidebar-$index"; 703 } else { 704 $index = sanitize_title( $index ); 705 foreach ( (array) $wp_registered_sidebars as $key => $value ) { 706 if ( sanitize_title( $value['name'] ) === $index ) { 707 $index = $key; 708 break; 709 } 710 } 711 } 712 713 $sidebars_widgets = wp_get_sidebars_widgets(); 714 if ( empty( $wp_registered_sidebars[ $index ] ) || empty( $sidebars_widgets[ $index ] ) || ! is_array( $sidebars_widgets[ $index ] ) ) { 715 /** This action is documented in wp-includes/widgets.php */ 716 do_action( 'dynamic_sidebar_before', $index, false ); 717 /** This action is documented in wp-includes/widgets.php */ 718 do_action( 'dynamic_sidebar_after', $index, false ); 719 /** This filter is documented in wp-includes/widgets.php */ 720 return apply_filters( 'dynamic_sidebar_has_widgets', false, $index ); 721 } 722 723 $sidebar = $wp_registered_sidebars[ $index ]; 724 725 $sidebar['before_sidebar'] = sprintf( $sidebar['before_sidebar'], $sidebar['id'], $sidebar['class'] ); 726 727 /** 728 * Fires before widgets are rendered in a dynamic sidebar. 729 * 730 * Note: The action also fires for empty sidebars, and on both the front end 731 * and back end, including the Inactive Widgets sidebar on the Widgets screen. 732 * 733 * @since 3.9.0 734 * 735 * @param int|string $index Index, name, or ID of the dynamic sidebar. 736 * @param bool $has_widgets Whether the sidebar is populated with widgets. 737 * Default true. 738 */ 739 do_action( 'dynamic_sidebar_before', $index, true ); 740 741 if ( ! is_admin() && ! empty( $sidebar['before_sidebar'] ) ) { 742 echo $sidebar['before_sidebar']; 743 } 744 745 $did_one = false; 746 foreach ( (array) $sidebars_widgets[ $index ] as $id ) { 747 748 if ( ! isset( $wp_registered_widgets[ $id ] ) ) { 749 continue; 750 } 751 752 $params = array_merge( 753 array( 754 array_merge( 755 $sidebar, 756 array( 757 'widget_id' => $id, 758 'widget_name' => $wp_registered_widgets[ $id ]['name'], 759 ) 760 ), 761 ), 762 (array) $wp_registered_widgets[ $id ]['params'] 763 ); 764 765 // Substitute HTML `id` and `class` attributes into `before_widget`. 766 $classname_ = ''; 767 foreach ( (array) $wp_registered_widgets[ $id ]['classname'] as $cn ) { 768 if ( is_string( $cn ) ) { 769 $classname_ .= '_' . $cn; 770 } elseif ( is_object( $cn ) ) { 771 $classname_ .= '_' . get_class( $cn ); 772 } 773 } 774 $classname_ = ltrim( $classname_, '_' ); 775 776 $params[0]['before_widget'] = sprintf( 777 $params[0]['before_widget'], 778 str_replace( '\\', '_', $id ), 779 $classname_ 780 ); 781 782 /** 783 * Filters the parameters passed to a widget's display callback. 784 * 785 * Note: The filter is evaluated on both the front end and back end, 786 * including for the Inactive Widgets sidebar on the Widgets screen. 787 * 788 * @since 2.5.0 789 * 790 * @see register_sidebar() 791 * 792 * @param array $params { 793 * The arguments the display callback is called with, in order. 794 * 795 * @type array $0 { 796 * An array of widget display arguments. 797 * 798 * @type string $name Name of the sidebar the widget is assigned to. 799 * @type string $id ID of the sidebar the widget is assigned to. 800 * @type string $description The sidebar description. 801 * @type string $class CSS class applied to the sidebar container. 802 * @type string $before_widget HTML markup to prepend to each widget in the sidebar. 803 * @type string $after_widget HTML markup to append to each widget in the sidebar. 804 * @type string $before_title HTML markup to prepend to the widget title when displayed. 805 * @type string $after_title HTML markup to append to the widget title when displayed. 806 * @type string $widget_id ID of the widget. 807 * @type string $widget_name Name of the widget. 808 * } 809 * @type array ...$1 { 810 * The parameters the widget was registered with, such as the multi-widget arguments. 811 * 812 * @type int $number Number increment used for multiples of the same widget. 813 * } 814 * } 815 */ 816 $params = apply_filters( 'dynamic_sidebar_params', $params ); 817 818 $callback = $wp_registered_widgets[ $id ]['callback']; 819 820 /** 821 * Fires before a widget's display callback is called. 822 * 823 * Note: The action fires on both the front end and back end, including 824 * for widgets in the Inactive Widgets sidebar on the Widgets screen. 825 * 826 * The action is not fired for empty sidebars. 827 * 828 * @since 3.0.0 829 * 830 * @param array $widget { 831 * An associative array of widget arguments. 832 * 833 * @type string $name Name of the widget. 834 * @type string $id Widget ID. 835 * @type callable $callback When the hook is fired on the front end, `$callback` is an array 836 * containing the widget object. Fired on the back end, `$callback` 837 * is 'wp_widget_control', see `$_callback`. 838 * @type array $params An associative array of multi-widget arguments. 839 * @type string $classname CSS class applied to the widget container. 840 * @type string $description The widget description. 841 * @type array $_callback When the hook is fired on the back end, `$_callback` is populated 842 * with an array containing the widget object, see `$callback`. 843 * } 844 */ 845 do_action( 'dynamic_sidebar', $wp_registered_widgets[ $id ] ); 846 847 if ( is_callable( $callback ) ) { 848 call_user_func_array( $callback, $params ); 849 $did_one = true; 850 } 851 } 852 853 if ( ! is_admin() && ! empty( $sidebar['after_sidebar'] ) ) { 854 echo $sidebar['after_sidebar']; 855 } 856 857 /** 858 * Fires after widgets are rendered in a dynamic sidebar. 859 * 860 * Note: The action also fires for empty sidebars, and on both the front end 861 * and back end, including the Inactive Widgets sidebar on the Widgets screen. 862 * 863 * @since 3.9.0 864 * 865 * @param int|string $index Index, name, or ID of the dynamic sidebar. 866 * @param bool $has_widgets Whether the sidebar is populated with widgets. 867 * Default true. 868 */ 869 do_action( 'dynamic_sidebar_after', $index, true ); 870 871 /** 872 * Filters whether a sidebar has widgets. 873 * 874 * Note: The filter is also evaluated for empty sidebars, and on both the front end 875 * and back end, including the Inactive Widgets sidebar on the Widgets screen. 876 * 877 * @since 3.9.0 878 * 879 * @param bool $did_one Whether at least one widget was rendered in the sidebar. 880 * Default false. 881 * @param int|string $index Index, name, or ID of the dynamic sidebar. 882 */ 883 return apply_filters( 'dynamic_sidebar_has_widgets', $did_one, $index ); 884 } 885 886 /** 887 * Determines whether a given widget is displayed on the front end. 888 * 889 * Either $callback or $id_base can be used. 890 * $id_base is the first argument when extending WP_Widget class. 891 * Without the optional $widget_id parameter, returns the ID of the first sidebar 892 * in which the first instance of the widget with the given callback or $id_base is found. 893 * With the $widget_id parameter, returns the ID of the sidebar where 894 * the widget with that callback/$id_base AND that ID is found. 895 * 896 * NOTE: $widget_id and $id_base are the same for single widgets. To be effective 897 * this function has to run after widgets have initialized, at action {@see 'init'} or later. 898 * 899 * For more information on this and similar theme functions, check out 900 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 901 * Conditional Tags} article in the Theme Developer Handbook. 902 * 903 * @since 2.2.0 904 * 905 * @global array $wp_registered_widgets The registered widgets. 906 * 907 * @param callable|false $callback Optional. Widget callback to check. Default false. 908 * @param string|false $widget_id Optional. Widget ID. Optional, but needed for checking. 909 * Default false. 910 * @param string|false $id_base Optional. The base ID of a widget created by extending WP_Widget. 911 * Default false. 912 * @param bool $skip_inactive Optional. Whether to check in 'wp_inactive_widgets'. 913 * Default true. 914 * @return string|false ID of the sidebar in which the widget is active, 915 * false if the widget is not active. 916 */ 917 function is_active_widget( $callback = false, $widget_id = false, $id_base = false, $skip_inactive = true ) { 918 global $wp_registered_widgets; 919 920 $sidebars_widgets = wp_get_sidebars_widgets(); 921 922 if ( is_array( $sidebars_widgets ) ) { 923 foreach ( $sidebars_widgets as $sidebar => $widgets ) { 924 if ( $skip_inactive && ( 'wp_inactive_widgets' === $sidebar || str_starts_with( $sidebar, 'orphaned_widgets' ) ) ) { 925 continue; 926 } 927 928 if ( is_array( $widgets ) ) { 929 foreach ( $widgets as $widget ) { 930 if ( ( $callback && isset( $wp_registered_widgets[ $widget ]['callback'] ) && $wp_registered_widgets[ $widget ]['callback'] === $callback ) || ( $id_base && _get_widget_id_base( $widget ) === $id_base ) ) { 931 if ( ! $widget_id || ( isset( $wp_registered_widgets[ $widget ]['id'] ) && $widget_id === $wp_registered_widgets[ $widget ]['id'] ) ) { 932 return $sidebar; 933 } 934 } 935 } 936 } 937 } 938 } 939 return false; 940 } 941 942 /** 943 * Determines whether the dynamic sidebar is enabled and used by the theme. 944 * 945 * For more information on this and similar theme functions, check out 946 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 947 * Conditional Tags} article in the Theme Developer Handbook. 948 * 949 * @since 2.2.0 950 * 951 * @global array $wp_registered_widgets The registered widgets. 952 * @global array $wp_registered_sidebars The registered sidebars. 953 * 954 * @return bool True if using widgets, false otherwise. 955 */ 956 function is_dynamic_sidebar() { 957 global $wp_registered_widgets, $wp_registered_sidebars; 958 959 $sidebars_widgets = get_option( 'sidebars_widgets' ); 960 961 foreach ( (array) $wp_registered_sidebars as $index => $sidebar ) { 962 if ( ! empty( $sidebars_widgets[ $index ] ) ) { 963 foreach ( (array) $sidebars_widgets[ $index ] as $widget ) { 964 if ( array_key_exists( $widget, $wp_registered_widgets ) ) { 965 return true; 966 } 967 } 968 } 969 } 970 971 return false; 972 } 973 974 /** 975 * Determines whether a sidebar contains widgets. 976 * 977 * For more information on this and similar theme functions, check out 978 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/ 979 * Conditional Tags} article in the Theme Developer Handbook. 980 * 981 * @since 2.8.0 982 * 983 * @param string|int $index Sidebar name, id or number to check. 984 * @return bool True if the sidebar has widgets, false otherwise. 985 */ 986 function is_active_sidebar( $index ) { 987 $index = ( is_int( $index ) ) ? "sidebar-$index" : sanitize_title( $index ); 988 $sidebars_widgets = wp_get_sidebars_widgets(); 989 $is_active_sidebar = ! empty( $sidebars_widgets[ $index ] ); 990 991 /** 992 * Filters whether a dynamic sidebar is considered "active". 993 * 994 * @since 3.9.0 995 * 996 * @param bool $is_active_sidebar Whether or not the sidebar should be considered "active". 997 * In other words, whether the sidebar contains any widgets. 998 * @param int|string $index Index, name, or ID of the dynamic sidebar. 999 */ 1000 return apply_filters( 'is_active_sidebar', $is_active_sidebar, $index ); 1001 } 1002 1003 // 1004 // Internal Functions. 1005 // 1006 1007 /** 1008 * Retrieves the full list of sidebars and their widget instance IDs. 1009 * 1010 * Will upgrade sidebar widget list, if needed. Will also save updated list, if 1011 * needed. 1012 * 1013 * @since 2.2.0 1014 * @access private 1015 * 1016 * @global array $_wp_sidebars_widgets 1017 * @global array $sidebars_widgets 1018 * 1019 * @param bool $deprecated Not used (argument deprecated). 1020 * @return array Upgraded list of widgets to version 3 array format when called from the admin. 1021 * 1022 * @phpstan-param true $deprecated 1023 */ 1024 function wp_get_sidebars_widgets( $deprecated = true ) { 1025 if ( true !== $deprecated ) { 1026 _deprecated_argument( __FUNCTION__, '2.8.1' ); 1027 } 1028 1029 global $_wp_sidebars_widgets, $sidebars_widgets; 1030 1031 /* 1032 * If loading from front page, consult $_wp_sidebars_widgets rather than options 1033 * to see if wp_convert_widget_settings() has made manipulations in memory. 1034 */ 1035 if ( ! is_admin() ) { 1036 if ( empty( $_wp_sidebars_widgets ) ) { 1037 $_wp_sidebars_widgets = get_option( 'sidebars_widgets', array() ); 1038 } 1039 1040 $sidebars_widgets = $_wp_sidebars_widgets; 1041 } else { 1042 $sidebars_widgets = get_option( 'sidebars_widgets', array() ); 1043 } 1044 1045 if ( is_array( $sidebars_widgets ) && isset( $sidebars_widgets['array_version'] ) ) { 1046 unset( $sidebars_widgets['array_version'] ); 1047 } 1048 1049 /** 1050 * Filters the list of sidebars and their widgets. 1051 * 1052 * @since 2.7.0 1053 * 1054 * @param array $sidebars_widgets An associative array of sidebars and their widgets. 1055 */ 1056 return apply_filters( 'sidebars_widgets', $sidebars_widgets ); 1057 } 1058 1059 /** 1060 * Retrieves the registered sidebar with the given ID. 1061 * 1062 * @since 5.9.0 1063 * 1064 * @global array $wp_registered_sidebars The registered sidebars. 1065 * 1066 * @param string $id The sidebar ID. 1067 * @return array|null The discovered sidebar, or null if it is not registered. 1068 */ 1069 function wp_get_sidebar( $id ) { 1070 global $wp_registered_sidebars; 1071 1072 foreach ( (array) $wp_registered_sidebars as $sidebar ) { 1073 if ( $sidebar['id'] === $id ) { 1074 return $sidebar; 1075 } 1076 } 1077 1078 if ( 'wp_inactive_widgets' === $id ) { 1079 return array( 1080 'id' => 'wp_inactive_widgets', 1081 'name' => __( 'Inactive widgets' ), 1082 ); 1083 } 1084 1085 return null; 1086 } 1087 1088 /** 1089 * Sets the sidebar widget option to update sidebars. 1090 * 1091 * @since 2.2.0 1092 * @access private 1093 * 1094 * @global array $_wp_sidebars_widgets 1095 * @param array $sidebars_widgets Sidebar widgets and their settings. 1096 */ 1097 function wp_set_sidebars_widgets( $sidebars_widgets ) { 1098 global $_wp_sidebars_widgets; 1099 1100 // Clear cached value used in wp_get_sidebars_widgets(). 1101 $_wp_sidebars_widgets = null; 1102 1103 if ( ! isset( $sidebars_widgets['array_version'] ) ) { 1104 $sidebars_widgets['array_version'] = 3; 1105 } 1106 1107 update_option( 'sidebars_widgets', $sidebars_widgets ); 1108 } 1109 1110 /** 1111 * Retrieves default registered sidebars list. 1112 * 1113 * @since 2.2.0 1114 * @access private 1115 * 1116 * @global array $wp_registered_sidebars The registered sidebars. 1117 * 1118 * @return array 1119 */ 1120 function wp_get_widget_defaults() { 1121 global $wp_registered_sidebars; 1122 1123 $defaults = array(); 1124 1125 foreach ( (array) $wp_registered_sidebars as $index => $sidebar ) { 1126 $defaults[ $index ] = array(); 1127 } 1128 1129 return $defaults; 1130 } 1131 1132 /** 1133 * Converts the widget settings from single to multi-widget format. 1134 * 1135 * @since 2.8.0 1136 * 1137 * @global array $_wp_sidebars_widgets 1138 * 1139 * @param string $base_name Root ID for all widgets of this type. 1140 * @param string $option_name Option name for this widget type. 1141 * @param array $settings The array of widget instance settings. 1142 * @return array The array of widget settings converted to multi-widget format. 1143 */ 1144 function wp_convert_widget_settings( $base_name, $option_name, $settings ) { 1145 // This test may need expanding. 1146 $single = false; 1147 $changed = false; 1148 1149 if ( empty( $settings ) ) { 1150 $single = true; 1151 } else { 1152 foreach ( array_keys( $settings ) as $number ) { 1153 if ( 'number' === $number ) { 1154 continue; 1155 } 1156 if ( ! is_numeric( $number ) ) { 1157 $single = true; 1158 break; 1159 } 1160 } 1161 } 1162 1163 if ( $single ) { 1164 $settings = array( 2 => $settings ); 1165 1166 // If loading from the front page, update sidebar in memory but don't save to options. 1167 if ( is_admin() ) { 1168 $sidebars_widgets = get_option( 'sidebars_widgets' ); 1169 } else { 1170 if ( empty( $GLOBALS['_wp_sidebars_widgets'] ) ) { 1171 $GLOBALS['_wp_sidebars_widgets'] = get_option( 'sidebars_widgets', array() ); 1172 } 1173 $sidebars_widgets = &$GLOBALS['_wp_sidebars_widgets']; 1174 } 1175 1176 foreach ( (array) $sidebars_widgets as $index => $sidebar ) { 1177 if ( is_array( $sidebar ) ) { 1178 foreach ( $sidebar as $i => $name ) { 1179 if ( $base_name === $name ) { 1180 $sidebars_widgets[ $index ][ $i ] = "$name-2"; 1181 $changed = true; 1182 break 2; 1183 } 1184 } 1185 } 1186 } 1187 1188 if ( is_admin() && $changed ) { 1189 update_option( 'sidebars_widgets', $sidebars_widgets ); 1190 } 1191 } 1192 1193 $settings['_multiwidget'] = 1; 1194 if ( is_admin() ) { 1195 update_option( $option_name, $settings ); 1196 } 1197 1198 return $settings; 1199 } 1200 1201 /** 1202 * Outputs an arbitrary widget as a template tag. 1203 * 1204 * @since 2.8.0 1205 * 1206 * @global WP_Widget_Factory $wp_widget_factory 1207 * 1208 * @param string $widget The widget's PHP class name (see class-wp-widget.php). 1209 * @param array $instance Optional. The widget's instance settings. Default empty array. 1210 * @param array $args { 1211 * Optional. Array of arguments to configure the display of the widget. 1212 * 1213 * @type string $before_widget HTML content that will be prepended to the widget's HTML output. 1214 * Default `<div class="widget %s">`, where `%s` is the widget's class name. 1215 * @type string $after_widget HTML content that will be appended to the widget's HTML output. 1216 * Default `</div>`. 1217 * @type string $before_title HTML content that will be prepended to the widget's title when displayed. 1218 * Default `<h2 class="widgettitle">`. 1219 * @type string $after_title HTML content that will be appended to the widget's title when displayed. 1220 * Default `</h2>`. 1221 * } 1222 */ 1223 function the_widget( $widget, $instance = array(), $args = array() ) { 1224 global $wp_widget_factory; 1225 1226 if ( ! isset( $wp_widget_factory->widgets[ $widget ] ) ) { 1227 _doing_it_wrong( 1228 __FUNCTION__, 1229 sprintf( 1230 /* translators: %s: register_widget() */ 1231 __( 'Widgets need to be registered using %s, before they can be displayed.' ), 1232 '<code>register_widget()</code>' 1233 ), 1234 '4.9.0' 1235 ); 1236 return; 1237 } 1238 1239 $widget_obj = $wp_widget_factory->widgets[ $widget ]; 1240 if ( ! ( $widget_obj instanceof WP_Widget ) ) { 1241 return; 1242 } 1243 1244 $default_args = array( 1245 'before_widget' => '<div class="widget %s">', 1246 'after_widget' => '</div>', 1247 'before_title' => '<h2 class="widgettitle">', 1248 'after_title' => '</h2>', 1249 ); 1250 $args = wp_parse_args( $args, $default_args ); 1251 $args['before_widget'] = sprintf( $args['before_widget'], $widget_obj->widget_options['classname'] ); 1252 1253 $instance = wp_parse_args( $instance ); 1254 1255 /** This filter is documented in wp-includes/class-wp-widget.php */ 1256 $instance = apply_filters( 'widget_display_callback', $instance, $widget_obj, $args ); 1257 1258 if ( false === $instance ) { 1259 return; 1260 } 1261 1262 /** 1263 * Fires before rendering the requested widget. 1264 * 1265 * @since 3.0.0 1266 * 1267 * @param string $widget The widget's class name. 1268 * @param array $instance The current widget instance's settings. 1269 * @param array $args An array of the widget's sidebar arguments. 1270 */ 1271 do_action( 'the_widget', $widget, $instance, $args ); 1272 1273 $widget_obj->_set( -1 ); 1274 $widget_obj->widget( $args, $instance ); 1275 } 1276 1277 /** 1278 * Retrieves the widget ID base value. 1279 * 1280 * @since 2.8.0 1281 * 1282 * @param string $id Widget ID. 1283 * @return string Widget ID base. 1284 */ 1285 function _get_widget_id_base( $id ) { 1286 return preg_replace( '/-[0-9]+$/', '', $id ); 1287 } 1288 1289 /** 1290 * Handles sidebars config after theme change. 1291 * 1292 * @access private 1293 * @since 3.3.0 1294 * 1295 * @global array $sidebars_widgets 1296 */ 1297 function _wp_sidebars_changed() { 1298 global $sidebars_widgets; 1299 1300 if ( ! is_array( $sidebars_widgets ) ) { 1301 $sidebars_widgets = wp_get_sidebars_widgets(); 1302 } 1303 1304 retrieve_widgets( true ); 1305 } 1306 1307 /** 1308 * Validates and remaps any "orphaned" widgets to wp_inactive_widgets sidebar, 1309 * and saves the widget settings. This has to run at least on each theme change. 1310 * 1311 * For example, let's say theme A has a "footer" sidebar, and theme B doesn't have one. 1312 * After switching from theme A to theme B, all the widgets previously assigned 1313 * to the footer would be inaccessible. This function detects this scenario, and 1314 * moves all the widgets previously assigned to the footer under wp_inactive_widgets. 1315 * 1316 * Despite the word "retrieve" in the name, this function actually updates the database 1317 * and the global `$sidebars_widgets`. For that reason it should not be run on front end, 1318 * unless the `$theme_changed` value is 'customize' (to bypass the database write). 1319 * 1320 * @since 2.8.0 1321 * 1322 * @global array $wp_registered_sidebars The registered sidebars. 1323 * @global array $sidebars_widgets 1324 * @global array $wp_registered_widgets The registered widgets. 1325 * 1326 * @param string|bool $theme_changed Whether the theme was changed as a boolean. A value 1327 * of 'customize' defers updates for the Customizer. 1328 * @return array Updated sidebars widgets. 1329 */ 1330 function retrieve_widgets( $theme_changed = false ) { 1331 global $wp_registered_sidebars, $sidebars_widgets, $wp_registered_widgets; 1332 1333 $registered_sidebars_keys = array_keys( $wp_registered_sidebars ); 1334 $registered_widgets_ids = array_keys( $wp_registered_widgets ); 1335 1336 if ( ! is_array( get_theme_mod( 'sidebars_widgets' ) ) ) { 1337 if ( empty( $sidebars_widgets ) ) { 1338 return array(); 1339 } 1340 1341 unset( $sidebars_widgets['array_version'] ); 1342 1343 $sidebars_widgets_keys = array_keys( $sidebars_widgets ); 1344 sort( $sidebars_widgets_keys ); 1345 sort( $registered_sidebars_keys ); 1346 1347 if ( $sidebars_widgets_keys === $registered_sidebars_keys ) { 1348 $sidebars_widgets = _wp_remove_unregistered_widgets( $sidebars_widgets, $registered_widgets_ids ); 1349 1350 return $sidebars_widgets; 1351 } 1352 } 1353 1354 // Discard invalid, theme-specific widgets from sidebars. 1355 $sidebars_widgets = _wp_remove_unregistered_widgets( $sidebars_widgets, $registered_widgets_ids ); 1356 $sidebars_widgets = wp_map_sidebars_widgets( $sidebars_widgets ); 1357 1358 // Replace non-array values inside the array with an empty array. 1359 foreach ( $sidebars_widgets as $key => $value ) { 1360 if ( ! is_array( $value ) ) { 1361 $sidebars_widgets[ $key ] = array(); 1362 } 1363 } 1364 1365 // Find hidden/lost multi-widget instances. 1366 $shown_widgets = array_merge( ...array_values( $sidebars_widgets ) ); 1367 $lost_widgets = array_diff( $registered_widgets_ids, $shown_widgets ); 1368 1369 foreach ( $lost_widgets as $key => $widget_id ) { 1370 $number = preg_replace( '/.+?-([0-9]+)$/', '$1', $widget_id ); 1371 1372 // Only keep active and default widgets. 1373 if ( is_numeric( $number ) && (int) $number < 2 ) { 1374 unset( $lost_widgets[ $key ] ); 1375 } 1376 } 1377 $sidebars_widgets['wp_inactive_widgets'] = array_merge( $lost_widgets, (array) $sidebars_widgets['wp_inactive_widgets'] ); 1378 1379 if ( 'customize' !== $theme_changed ) { 1380 // Update the widgets settings in the database. 1381 wp_set_sidebars_widgets( $sidebars_widgets ); 1382 } 1383 1384 return $sidebars_widgets; 1385 } 1386 1387 /** 1388 * Compares a list of sidebars with their widgets against an allowed list. 1389 * 1390 * @since 4.9.0 1391 * @since 4.9.2 Always tries to restore widget assignments from previous data, not just if sidebars needed mapping. 1392 * 1393 * @global array $wp_registered_sidebars The registered sidebars. 1394 * 1395 * @param array $existing_sidebars_widgets List of sidebars and their widget instance IDs. 1396 * @return array Mapped sidebars widgets. 1397 */ 1398 function wp_map_sidebars_widgets( $existing_sidebars_widgets ) { 1399 global $wp_registered_sidebars; 1400 1401 $new_sidebars_widgets = array( 1402 'wp_inactive_widgets' => array(), 1403 ); 1404 1405 // Short-circuit if there are no sidebars to map. 1406 if ( ! is_array( $existing_sidebars_widgets ) || empty( $existing_sidebars_widgets ) ) { 1407 return $new_sidebars_widgets; 1408 } 1409 1410 foreach ( $existing_sidebars_widgets as $sidebar => $widgets ) { 1411 if ( 'wp_inactive_widgets' === $sidebar || str_starts_with( $sidebar, 'orphaned_widgets' ) ) { 1412 $new_sidebars_widgets['wp_inactive_widgets'] = array_merge( $new_sidebars_widgets['wp_inactive_widgets'], (array) $widgets ); 1413 unset( $existing_sidebars_widgets[ $sidebar ] ); 1414 } 1415 } 1416 1417 // If old and new theme have just one sidebar, map it and we're done. 1418 if ( 1 === count( $existing_sidebars_widgets ) && 1 === count( $wp_registered_sidebars ) ) { 1419 $new_sidebars_widgets[ key( $wp_registered_sidebars ) ] = array_pop( $existing_sidebars_widgets ); 1420 1421 return $new_sidebars_widgets; 1422 } 1423 1424 // Map locations with the same slug. 1425 $existing_sidebars = array_keys( $existing_sidebars_widgets ); 1426 1427 foreach ( $wp_registered_sidebars as $sidebar => $name ) { 1428 if ( in_array( $sidebar, $existing_sidebars, true ) ) { 1429 $new_sidebars_widgets[ $sidebar ] = $existing_sidebars_widgets[ $sidebar ]; 1430 unset( $existing_sidebars_widgets[ $sidebar ] ); 1431 } elseif ( ! array_key_exists( $sidebar, $new_sidebars_widgets ) ) { 1432 $new_sidebars_widgets[ $sidebar ] = array(); 1433 } 1434 } 1435 1436 // If there are more sidebars, try to map them. 1437 if ( ! empty( $existing_sidebars_widgets ) ) { 1438 1439 /* 1440 * If old and new theme both have sidebars that contain phrases 1441 * from within the same group, make an educated guess and map it. 1442 */ 1443 $common_slug_groups = array( 1444 array( 'sidebar', 'primary', 'main', 'right' ), 1445 array( 'second', 'left' ), 1446 array( 'sidebar-2', 'footer', 'bottom' ), 1447 array( 'header', 'top' ), 1448 ); 1449 1450 // Go through each group... 1451 foreach ( $common_slug_groups as $slug_group ) { 1452 1453 // ...and see if any of these slugs... 1454 foreach ( $slug_group as $slug ) { 1455 1456 // ...and any of the new sidebars... 1457 foreach ( $wp_registered_sidebars as $new_sidebar => $args ) { 1458 1459 // ...actually match! 1460 if ( false === stripos( $new_sidebar, $slug ) && false === stripos( $slug, $new_sidebar ) ) { 1461 continue; 1462 } 1463 1464 // Then see if any of the existing sidebars... 1465 foreach ( $existing_sidebars_widgets as $sidebar => $widgets ) { 1466 1467 // ...and any slug in the same group... 1468 foreach ( $slug_group as $slug ) { 1469 1470 // ... have a match as well. 1471 if ( false === stripos( $sidebar, $slug ) && false === stripos( $slug, $sidebar ) ) { 1472 continue; 1473 } 1474 1475 // Make sure this sidebar wasn't mapped and removed previously. 1476 if ( ! empty( $existing_sidebars_widgets[ $sidebar ] ) ) { 1477 1478 // We have a match that can be mapped! 1479 $new_sidebars_widgets[ $new_sidebar ] = array_merge( $new_sidebars_widgets[ $new_sidebar ], $existing_sidebars_widgets[ $sidebar ] ); 1480 1481 // Remove the mapped sidebar so it can't be mapped again. 1482 unset( $existing_sidebars_widgets[ $sidebar ] ); 1483 1484 // Go back and check the next new sidebar. 1485 continue 3; 1486 } 1487 } // End foreach ( $slug_group as $slug ). 1488 } // End foreach ( $existing_sidebars_widgets as $sidebar => $widgets ). 1489 } // End foreach ( $wp_registered_sidebars as $new_sidebar => $args ). 1490 } // End foreach ( $slug_group as $slug ). 1491 } // End foreach ( $common_slug_groups as $slug_group ). 1492 } 1493 1494 // Move any left over widgets to inactive sidebar. 1495 foreach ( $existing_sidebars_widgets as $widgets ) { 1496 if ( is_array( $widgets ) && ! empty( $widgets ) ) { 1497 $new_sidebars_widgets['wp_inactive_widgets'] = array_merge( $new_sidebars_widgets['wp_inactive_widgets'], $widgets ); 1498 } 1499 } 1500 1501 // Sidebars_widgets settings from when this theme was previously active. 1502 $old_sidebars_widgets = get_theme_mod( 'sidebars_widgets' ); 1503 $old_sidebars_widgets = $old_sidebars_widgets['data'] ?? false; 1504 1505 if ( is_array( $old_sidebars_widgets ) ) { 1506 1507 // Remove empty sidebars, no need to map those. 1508 $old_sidebars_widgets = array_filter( $old_sidebars_widgets ); 1509 1510 // Only check sidebars that are empty or have not been mapped to yet. 1511 foreach ( $new_sidebars_widgets as $new_sidebar => $new_widgets ) { 1512 if ( array_key_exists( $new_sidebar, $old_sidebars_widgets ) && ! empty( $new_widgets ) ) { 1513 unset( $old_sidebars_widgets[ $new_sidebar ] ); 1514 } 1515 } 1516 1517 // Remove orphaned widgets, we're only interested in previously active sidebars. 1518 foreach ( $old_sidebars_widgets as $sidebar => $widgets ) { 1519 if ( str_starts_with( $sidebar, 'orphaned_widgets' ) ) { 1520 unset( $old_sidebars_widgets[ $sidebar ] ); 1521 } 1522 } 1523 1524 $old_sidebars_widgets = _wp_remove_unregistered_widgets( $old_sidebars_widgets ); 1525 1526 // Replace non-array values inside the array with an empty array. 1527 foreach ( $new_sidebars_widgets as $key => $value ) { 1528 if ( ! is_array( $value ) ) { 1529 $new_sidebars_widgets[ $key ] = array(); 1530 } 1531 } 1532 1533 if ( ! empty( $old_sidebars_widgets ) ) { 1534 1535 // Go through each remaining sidebar... 1536 foreach ( $old_sidebars_widgets as $old_sidebar => $old_widgets ) { 1537 1538 // ...and check every new sidebar... 1539 foreach ( $new_sidebars_widgets as $new_sidebar => $new_widgets ) { 1540 1541 // ...for every widget we're trying to revive. 1542 foreach ( $old_widgets as $key => $widget_id ) { 1543 $active_key = array_search( $widget_id, $new_widgets, true ); 1544 1545 // If the widget is used elsewhere... 1546 if ( false !== $active_key ) { 1547 1548 // ...and that elsewhere is inactive widgets... 1549 if ( 'wp_inactive_widgets' === $new_sidebar ) { 1550 1551 // ...remove it from there and keep the active version... 1552 unset( $new_sidebars_widgets['wp_inactive_widgets'][ $active_key ] ); 1553 } else { 1554 1555 // ...otherwise remove it from the old sidebar and keep it in the new one. 1556 unset( $old_sidebars_widgets[ $old_sidebar ][ $key ] ); 1557 } 1558 } // End if ( $active_key ). 1559 } // End foreach ( $old_widgets as $key => $widget_id ). 1560 } // End foreach ( $new_sidebars_widgets as $new_sidebar => $new_widgets ). 1561 } // End foreach ( $old_sidebars_widgets as $old_sidebar => $old_widgets ). 1562 } // End if ( ! empty( $old_sidebars_widgets ) ). 1563 1564 // Restore widget settings from when theme was previously active. 1565 $new_sidebars_widgets = array_merge( $new_sidebars_widgets, $old_sidebars_widgets ); 1566 } 1567 1568 return $new_sidebars_widgets; 1569 } 1570 1571 /** 1572 * Compares a list of sidebars with their widgets against an allowed list. 1573 * 1574 * @since 4.9.0 1575 * 1576 * @global array $wp_registered_widgets The registered widgets. 1577 * 1578 * @param array $sidebars_widgets List of sidebars and their widget instance IDs. 1579 * @param array $allowed_widget_ids Optional. List of widget IDs to compare against. Default: Registered widgets. 1580 * @return array Sidebars with allowed widgets. 1581 */ 1582 function _wp_remove_unregistered_widgets( $sidebars_widgets, $allowed_widget_ids = array() ) { 1583 if ( empty( $allowed_widget_ids ) ) { 1584 $allowed_widget_ids = array_keys( $GLOBALS['wp_registered_widgets'] ); 1585 } 1586 1587 foreach ( $sidebars_widgets as $sidebar => $widgets ) { 1588 if ( is_array( $widgets ) ) { 1589 $sidebars_widgets[ $sidebar ] = array_intersect( $widgets, $allowed_widget_ids ); 1590 } 1591 } 1592 1593 return $sidebars_widgets; 1594 } 1595 1596 /** 1597 * Displays the RSS entries in a list. 1598 * 1599 * @since 2.5.0 1600 * 1601 * @param string|array|object $rss RSS url. 1602 * @param array $args Widget arguments. 1603 */ 1604 function wp_widget_rss_output( $rss, $args = array() ) { 1605 if ( is_string( $rss ) ) { 1606 $rss = fetch_feed( $rss ); 1607 } elseif ( is_array( $rss ) && isset( $rss['url'] ) ) { 1608 $args = $rss; 1609 $rss = fetch_feed( $rss['url'] ); 1610 } elseif ( ! is_object( $rss ) ) { 1611 return; 1612 } 1613 1614 if ( is_wp_error( $rss ) ) { 1615 if ( is_admin() || current_user_can( 'manage_options' ) ) { 1616 echo '<p><strong>' . __( 'RSS Error:' ) . '</strong> ' . esc_html( $rss->get_error_message() ) . '</p>'; 1617 } 1618 return; 1619 } 1620 1621 $default_args = array( 1622 'show_author' => 0, 1623 'show_date' => 0, 1624 'show_summary' => 0, 1625 'items' => 0, 1626 ); 1627 $args = wp_parse_args( $args, $default_args ); 1628 1629 $items = (int) $args['items']; 1630 if ( $items < 1 || 20 < $items ) { 1631 $items = 10; 1632 } 1633 $show_summary = (int) $args['show_summary']; 1634 $show_author = (int) $args['show_author']; 1635 $show_date = (int) $args['show_date']; 1636 1637 if ( ! $rss->get_item_quantity() ) { 1638 echo '<ul><li>' . __( 'An error has occurred, which probably means the feed is down. Try again later.' ) . '</li></ul>'; 1639 $rss->__destruct(); 1640 unset( $rss ); 1641 return; 1642 } 1643 1644 $blog_charset = get_option( 'blog_charset' ); 1645 $date_format = $show_date ? get_option( 'date_format' ) : ''; 1646 1647 echo '<ul>'; 1648 foreach ( $rss->get_items( 0, $items ) as $item ) { 1649 $link = $item->get_link(); 1650 while ( ! empty( $link ) && stristr( $link, 'http' ) !== $link ) { 1651 $link = substr( $link, 1 ); 1652 } 1653 $link = esc_url( strip_tags( $link ) ); 1654 1655 $title = esc_html( trim( strip_tags( $item->get_title() ) ) ); 1656 if ( empty( $title ) ) { 1657 $title = __( 'Untitled' ); 1658 } 1659 1660 $desc = html_entity_decode( $item->get_description(), ENT_QUOTES, $blog_charset ); 1661 $desc = esc_attr( wp_trim_words( $desc, 55, ' […]' ) ); 1662 1663 $summary = ''; 1664 if ( $show_summary ) { 1665 $summary = $desc; 1666 1667 // Change existing [...] to […]. 1668 if ( str_ends_with( $summary, '[...]' ) ) { 1669 $summary = substr( $summary, 0, -5 ) . '[…]'; 1670 } 1671 1672 $summary = '<div class="rssSummary">' . esc_html( $summary ) . '</div>'; 1673 } 1674 1675 $date = ''; 1676 if ( $show_date ) { 1677 $date = $item->get_date( 'U' ); 1678 1679 if ( $date ) { 1680 $date = ' <span class="rss-date">' . date_i18n( $date_format, $date ) . '</span>'; 1681 } 1682 } 1683 1684 $author = ''; 1685 if ( $show_author ) { 1686 $author = $item->get_author(); 1687 if ( is_object( $author ) ) { 1688 $author = $author->get_name(); 1689 $author = ' <cite>' . esc_html( strip_tags( $author ) ) . '</cite>'; 1690 } 1691 } 1692 1693 if ( '' === $link ) { 1694 echo "<li>$title{$date}{$summary}{$author}</li>"; 1695 } elseif ( $show_summary ) { 1696 echo "<li><a class='rsswidget' href='$link'>$title</a>{$date}{$summary}{$author}</li>"; 1697 } else { 1698 echo "<li><a class='rsswidget' href='$link'>$title</a>{$date}{$author}</li>"; 1699 } 1700 } 1701 echo '</ul>'; 1702 $rss->__destruct(); 1703 unset( $rss ); 1704 } 1705 1706 /** 1707 * Displays RSS widget options form. 1708 * 1709 * The options for what fields are displayed for the RSS form are all booleans 1710 * and are as follows: 'url', 'title', 'items', 'show_summary', 'show_author', 1711 * 'show_date'. 1712 * 1713 * @since 2.5.0 1714 * 1715 * @param array|string $args Values for input fields. 1716 * @param array $inputs Override default display options. 1717 */ 1718 function wp_widget_rss_form( $args, $inputs = null ) { 1719 $default_inputs = array( 1720 'url' => true, 1721 'title' => true, 1722 'items' => true, 1723 'show_summary' => true, 1724 'show_author' => true, 1725 'show_date' => true, 1726 ); 1727 $inputs = wp_parse_args( $inputs, $default_inputs ); 1728 1729 $args['title'] ??= ''; 1730 $args['url'] ??= ''; 1731 $args['items'] = (int) ( $args['items'] ?? 0 ); 1732 1733 if ( $args['items'] < 1 || 20 < $args['items'] ) { 1734 $args['items'] = 10; 1735 } 1736 1737 $args['show_summary'] = (int) ( $args['show_summary'] ?? $inputs['show_summary'] ); 1738 $args['show_author'] = (int) ( $args['show_author'] ?? $inputs['show_author'] ); 1739 $args['show_date'] = (int) ( $args['show_date'] ?? $inputs['show_date'] ); 1740 1741 if ( ! empty( $args['error'] ) ) { 1742 echo '<p class="widget-error"><strong>' . __( 'RSS Error:' ) . '</strong> ' . esc_html( $args['error'] ) . '</p>'; 1743 } 1744 1745 $esc_number = esc_attr( $args['number'] ); 1746 if ( $inputs['url'] ) : 1747 ?> 1748 <p><label for="rss-url-<?php echo $esc_number; ?>"><?php _e( 'Enter the RSS feed URL here:' ); ?></label> 1749 <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> 1750 <?php endif; if ( $inputs['title'] ) : ?> 1751 <p><label for="rss-title-<?php echo $esc_number; ?>"><?php _e( 'Give the feed a title (optional):' ); ?></label> 1752 <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> 1753 <?php endif; if ( $inputs['items'] ) : ?> 1754 <p><label for="rss-items-<?php echo $esc_number; ?>"><?php _e( 'How many items would you like to display?' ); ?></label> 1755 <select id="rss-items-<?php echo $esc_number; ?>" name="widget-rss[<?php echo $esc_number; ?>][items]"> 1756 <?php 1757 for ( $i = 1; $i <= 20; ++$i ) { 1758 echo "<option value='$i' " . selected( $args['items'], $i, false ) . ">$i</option>"; 1759 } 1760 ?> 1761 </select></p> 1762 <?php endif; if ( $inputs['show_summary'] || $inputs['show_author'] || $inputs['show_date'] ) : ?> 1763 <p> 1764 <?php if ( $inputs['show_summary'] ) : ?> 1765 <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'] ); ?> /> 1766 <label for="rss-show-summary-<?php echo $esc_number; ?>"><?php _e( 'Display item content?' ); ?></label><br /> 1767 <?php endif; if ( $inputs['show_author'] ) : ?> 1768 <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'] ); ?> /> 1769 <label for="rss-show-author-<?php echo $esc_number; ?>"><?php _e( 'Display item author if available?' ); ?></label><br /> 1770 <?php endif; if ( $inputs['show_date'] ) : ?> 1771 <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'] ); ?> /> 1772 <label for="rss-show-date-<?php echo $esc_number; ?>"><?php _e( 'Display item date?' ); ?></label><br /> 1773 <?php endif; ?> 1774 </p> 1775 <?php 1776 endif; // End of display options. 1777 foreach ( array_keys( $default_inputs ) as $input ) : 1778 if ( 'hidden' === $inputs[ $input ] ) : 1779 $id = str_replace( '_', '-', $input ); 1780 ?> 1781 <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 ] ); ?>" /> 1782 <?php 1783 endif; 1784 endforeach; 1785 } 1786 1787 /** 1788 * Processes RSS feed widget data and optionally retrieve feed items. 1789 * 1790 * The feed widget can not have more than 20 items or it will reset back to the 1791 * default, which is 10. 1792 * 1793 * The resulting array has the feed title, feed url, feed link (from channel), 1794 * feed items, error (if any), and whether to show summary, author, and date. 1795 * All respectively in the order of the array elements. 1796 * 1797 * @since 2.5.0 1798 * 1799 * @param array $widget_rss RSS widget feed data. Expects unescaped data. 1800 * @param bool $check_feed Optional. Whether to check feed for errors. Default true. 1801 * @return array 1802 */ 1803 function wp_widget_rss_process( $widget_rss, $check_feed = true ) { 1804 $items = (int) $widget_rss['items']; 1805 if ( $items < 1 || 20 < $items ) { 1806 $items = 10; 1807 } 1808 $url = sanitize_url( strip_tags( $widget_rss['url'] ) ); 1809 $title = trim( strip_tags( $widget_rss['title'] ?? '' ) ); 1810 $show_summary = (int) ( $widget_rss['show_summary'] ?? 0 ); 1811 $show_author = (int) ( $widget_rss['show_author'] ?? 0 ); 1812 $show_date = (int) ( $widget_rss['show_date'] ?? 0 ); 1813 $error = false; 1814 $link = ''; 1815 1816 if ( $check_feed ) { 1817 $rss = fetch_feed( $url ); 1818 1819 if ( is_wp_error( $rss ) ) { 1820 $error = $rss->get_error_message(); 1821 } else { 1822 $link = esc_url( strip_tags( $rss->get_permalink() ) ); 1823 while ( stristr( $link, 'http' ) !== $link ) { 1824 $link = substr( $link, 1 ); 1825 } 1826 1827 $rss->__destruct(); 1828 unset( $rss ); 1829 } 1830 } 1831 1832 return compact( 'title', 'url', 'link', 'items', 'error', 'show_summary', 'show_author', 'show_date' ); 1833 } 1834 1835 /** 1836 * Registers all of the default WordPress widgets on startup. 1837 * 1838 * Calls {@see 'widgets_init'} action after all of the WordPress widgets have been registered. 1839 * 1840 * @since 2.2.0 1841 */ 1842 function wp_widgets_init() { 1843 if ( ! is_blog_installed() ) { 1844 return; 1845 } 1846 1847 register_widget( 'WP_Widget_Pages' ); 1848 1849 register_widget( 'WP_Widget_Calendar' ); 1850 1851 register_widget( 'WP_Widget_Archives' ); 1852 1853 if ( get_option( 'link_manager_enabled' ) ) { 1854 register_widget( 'WP_Widget_Links' ); 1855 } 1856 1857 register_widget( 'WP_Widget_Media_Audio' ); 1858 1859 register_widget( 'WP_Widget_Media_Image' ); 1860 1861 register_widget( 'WP_Widget_Media_Gallery' ); 1862 1863 register_widget( 'WP_Widget_Media_Video' ); 1864 1865 register_widget( 'WP_Widget_Meta' ); 1866 1867 register_widget( 'WP_Widget_Search' ); 1868 1869 register_widget( 'WP_Widget_Text' ); 1870 1871 register_widget( 'WP_Widget_Categories' ); 1872 1873 register_widget( 'WP_Widget_Recent_Posts' ); 1874 1875 register_widget( 'WP_Widget_Recent_Comments' ); 1876 1877 register_widget( 'WP_Widget_RSS' ); 1878 1879 register_widget( 'WP_Widget_Tag_Cloud' ); 1880 1881 register_widget( 'WP_Nav_Menu_Widget' ); 1882 1883 register_widget( 'WP_Widget_Custom_HTML' ); 1884 1885 register_widget( 'WP_Widget_Block' ); 1886 1887 /** 1888 * Fires after all default WordPress widgets have been registered. 1889 * 1890 * @since 2.2.0 1891 */ 1892 do_action( 'widgets_init' ); 1893 } 1894 1895 /** 1896 * Enables the widgets block editor. This is hooked into 'after_setup_theme' so 1897 * that the block editor is enabled by default but can be disabled by themes. 1898 * 1899 * @since 5.8.0 1900 * 1901 * @access private 1902 */ 1903 function wp_setup_widgets_block_editor() { 1904 add_theme_support( 'widgets-block-editor' ); 1905 } 1906 1907 /** 1908 * Determines whether or not to use the block editor to manage widgets. 1909 * Defaults to true unless a theme has removed support for widgets-block-editor 1910 * or a plugin has filtered the return value of this function. 1911 * 1912 * @since 5.8.0 1913 * 1914 * @return bool Whether to use the block editor to manage widgets. 1915 */ 1916 function wp_use_widgets_block_editor() { 1917 /** 1918 * Filters whether to use the block editor to manage widgets. 1919 * 1920 * @since 5.8.0 1921 * 1922 * @param bool $use_widgets_block_editor Whether to use the block editor to manage widgets. 1923 */ 1924 return apply_filters( 1925 'use_widgets_block_editor', 1926 get_theme_support( 'widgets-block-editor' ) 1927 ); 1928 } 1929 1930 /** 1931 * Converts a widget ID into its id_base and number components. 1932 * 1933 * @since 5.8.0 1934 * 1935 * @param string $id Widget ID. 1936 * @return array Array containing a widget's id_base and number components. 1937 */ 1938 function wp_parse_widget_id( $id ) { 1939 $parsed = array(); 1940 1941 if ( preg_match( '/^(.+)-(\d+)$/', $id, $matches ) ) { 1942 $parsed['id_base'] = $matches[1]; 1943 $parsed['number'] = (int) $matches[2]; 1944 } else { 1945 // Likely an old single widget. 1946 $parsed['id_base'] = $id; 1947 } 1948 1949 return $parsed; 1950 } 1951 1952 /** 1953 * Finds the sidebar that a given widget belongs to. 1954 * 1955 * @since 5.8.0 1956 * 1957 * @param string $widget_id The widget ID to look for. 1958 * @return string|null The found sidebar's ID, or null if it was not found. 1959 */ 1960 function wp_find_widgets_sidebar( $widget_id ) { 1961 foreach ( wp_get_sidebars_widgets() as $sidebar_id => $widget_ids ) { 1962 foreach ( $widget_ids as $maybe_widget_id ) { 1963 if ( $maybe_widget_id === $widget_id ) { 1964 return (string) $sidebar_id; 1965 } 1966 } 1967 } 1968 1969 return null; 1970 } 1971 1972 /** 1973 * Assigns a widget to the given sidebar. 1974 * 1975 * @since 5.8.0 1976 * 1977 * @param string $widget_id The widget ID to assign. 1978 * @param string $sidebar_id The sidebar ID to assign to. If empty, the widget won't be added to any sidebar. 1979 */ 1980 function wp_assign_widget_to_sidebar( $widget_id, $sidebar_id ) { 1981 $sidebars = wp_get_sidebars_widgets(); 1982 1983 foreach ( $sidebars as $maybe_sidebar_id => $widgets ) { 1984 foreach ( $widgets as $i => $maybe_widget_id ) { 1985 if ( $widget_id === $maybe_widget_id && $sidebar_id !== $maybe_sidebar_id ) { 1986 unset( $sidebars[ $maybe_sidebar_id ][ $i ] ); 1987 // We could technically break 2 here, but continue looping in case the ID is duplicated. 1988 continue 2; 1989 } 1990 } 1991 } 1992 1993 if ( $sidebar_id ) { 1994 $sidebars[ $sidebar_id ][] = $widget_id; 1995 } 1996 1997 wp_set_sidebars_widgets( $sidebars ); 1998 } 1999 2000 /** 2001 * Calls the render callback of a widget and returns the output. 2002 * 2003 * @since 5.8.0 2004 * 2005 * @global array $wp_registered_widgets The registered widgets. 2006 * @global array $wp_registered_sidebars The registered sidebars. 2007 * 2008 * @param string $widget_id Widget ID. 2009 * @param string $sidebar_id Sidebar ID. 2010 * @return string 2011 */ 2012 function wp_render_widget( $widget_id, $sidebar_id ) { 2013 global $wp_registered_widgets, $wp_registered_sidebars; 2014 2015 if ( ! isset( $wp_registered_widgets[ $widget_id ] ) ) { 2016 return ''; 2017 } 2018 2019 if ( isset( $wp_registered_sidebars[ $sidebar_id ] ) ) { 2020 $sidebar = $wp_registered_sidebars[ $sidebar_id ]; 2021 } elseif ( 'wp_inactive_widgets' === $sidebar_id ) { 2022 $sidebar = array(); 2023 } else { 2024 return ''; 2025 } 2026 2027 $params = array_merge( 2028 array( 2029 array_merge( 2030 $sidebar, 2031 array( 2032 'widget_id' => $widget_id, 2033 'widget_name' => $wp_registered_widgets[ $widget_id ]['name'], 2034 ) 2035 ), 2036 ), 2037 (array) $wp_registered_widgets[ $widget_id ]['params'] 2038 ); 2039 2040 // Substitute HTML `id` and `class` attributes into `before_widget`. 2041 $classname_ = ''; 2042 foreach ( (array) $wp_registered_widgets[ $widget_id ]['classname'] as $cn ) { 2043 if ( is_string( $cn ) ) { 2044 $classname_ .= '_' . $cn; 2045 } elseif ( is_object( $cn ) ) { 2046 $classname_ .= '_' . get_class( $cn ); 2047 } 2048 } 2049 $classname_ = ltrim( $classname_, '_' ); 2050 $params[0]['before_widget'] = sprintf( $params[0]['before_widget'], $widget_id, $classname_ ); 2051 2052 /** This filter is documented in wp-includes/widgets.php */ 2053 $params = apply_filters( 'dynamic_sidebar_params', $params ); 2054 2055 $callback = $wp_registered_widgets[ $widget_id ]['callback']; 2056 2057 ob_start(); 2058 2059 /** This filter is documented in wp-includes/widgets.php */ 2060 do_action( 'dynamic_sidebar', $wp_registered_widgets[ $widget_id ] ); 2061 2062 if ( is_callable( $callback ) ) { 2063 call_user_func_array( $callback, $params ); 2064 } 2065 2066 return ob_get_clean(); 2067 } 2068 2069 /** 2070 * Calls the control callback of a widget and returns the output. 2071 * 2072 * @since 5.8.0 2073 * 2074 * @global array $wp_registered_widget_controls The registered widget controls. 2075 * 2076 * @param string $id Widget ID. 2077 * @return string|null 2078 */ 2079 function wp_render_widget_control( $id ) { 2080 global $wp_registered_widget_controls; 2081 2082 if ( ! isset( $wp_registered_widget_controls[ $id ]['callback'] ) ) { 2083 return null; 2084 } 2085 2086 $callback = $wp_registered_widget_controls[ $id ]['callback']; 2087 $params = $wp_registered_widget_controls[ $id ]['params']; 2088 2089 ob_start(); 2090 2091 if ( is_callable( $callback ) ) { 2092 call_user_func_array( $callback, $params ); 2093 } 2094 2095 return ob_get_clean(); 2096 } 2097 2098 /** 2099 * Displays a _doing_it_wrong() message for conflicting widget editor scripts. 2100 * 2101 * The 'wp-editor' script module is exposed as window.wp.editor. This overrides 2102 * the legacy TinyMCE editor module which is required by the widgets editor. 2103 * Because of that conflict, these two shouldn't be enqueued together. 2104 * See https://core.trac.wordpress.org/ticket/53569. 2105 * 2106 * There is also another conflict related to styles where the block widgets 2107 * editor is hidden if a block enqueues 'wp-edit-post' stylesheet. 2108 * See https://core.trac.wordpress.org/ticket/53569. 2109 * 2110 * @since 5.8.0 2111 * @access private 2112 * 2113 * @global WP_Scripts $wp_scripts 2114 * @global WP_Styles $wp_styles 2115 */ 2116 function wp_check_widget_editor_deps() { 2117 global $wp_scripts, $wp_styles; 2118 2119 if ( 2120 $wp_scripts->query( 'wp-edit-widgets', 'enqueued' ) || 2121 $wp_scripts->query( 'wp-customize-widgets', 'enqueued' ) 2122 ) { 2123 if ( $wp_scripts->query( 'wp-editor', 'enqueued' ) ) { 2124 _doing_it_wrong( 2125 'wp_enqueue_script()', 2126 sprintf( 2127 /* translators: 1: 'wp-editor', 2: 'wp-edit-widgets', 3: 'wp-customize-widgets'. */ 2128 __( '"%1$s" script should not be enqueued together with the new widgets editor (%2$s or %3$s).' ), 2129 'wp-editor', 2130 'wp-edit-widgets', 2131 'wp-customize-widgets' 2132 ), 2133 '5.8.0' 2134 ); 2135 } 2136 if ( $wp_styles->query( 'wp-edit-post', 'enqueued' ) ) { 2137 _doing_it_wrong( 2138 'wp_enqueue_style()', 2139 sprintf( 2140 /* translators: 1: 'wp-edit-post', 2: 'wp-edit-widgets', 3: 'wp-customize-widgets'. */ 2141 __( '"%1$s" style should not be enqueued together with the new widgets editor (%2$s or %3$s).' ), 2142 'wp-edit-post', 2143 'wp-edit-widgets', 2144 'wp-customize-widgets' 2145 ), 2146 '5.8.0' 2147 ); 2148 } 2149 } 2150 } 2151 2152 /** 2153 * Registers the previous theme's sidebars for the block themes. 2154 * 2155 * @since 6.2.0 2156 * @access private 2157 * 2158 * @global array $wp_registered_sidebars The registered sidebars. 2159 */ 2160 function _wp_block_theme_register_classic_sidebars() { 2161 global $wp_registered_sidebars; 2162 2163 if ( ! wp_is_block_theme() ) { 2164 return; 2165 } 2166 2167 $classic_sidebars = get_theme_mod( 'wp_classic_sidebars' ); 2168 if ( empty( $classic_sidebars ) ) { 2169 return; 2170 } 2171 2172 // Don't use `register_sidebar` since it will enable the `widgets` support for a theme. 2173 foreach ( $classic_sidebars as $sidebar ) { 2174 $wp_registered_sidebars[ $sidebar['id'] ] = $sidebar; 2175 } 2176 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Tue Oct 13 08:20:33 2026 | Cross-referenced by PHPXref |