enmi-conf.org: comparison wp/wp-includes/widgets.php

equal deleted inserted replaced

-:7b1b88e27a20
+:48c4eec2b7e6
 * Includes both internal WordPress routines and theme-use routines.
 *
 * This functionality was found in a plugin before the WordPress 2.2 release, which
 * included it in the core from that point on.
 *
-* @link https://wordpress.org/support/article/wordpress-widgets/
+* @link https://wordpress.org/documentation/article/manage-wordpress-widgets/
 * @link https://developer.wordpress.org/themes/functionality/widgets/
 *
 * @package WordPress
 * @subpackage Widgets
 * @since 2.2.0
 global $wp_registered_sidebars, $wp_registered_widgets, $wp_registered_widget_controls, $wp_registered_widget_updates;
 /**
 * Stores the sidebars, since many themes can have more than one.
 *
-* @global array $wp_registered_sidebars Registered sidebars.
 * @since 2.2.0
+*
+* @global array $wp_registered_sidebars The registered sidebars.
 */
 $wp_registered_sidebars = array();
 /**
 * Stores the registered widgets.
 *
-* @global array $wp_registered_widgets
 * @since 2.2.0
+*
+* @global array $wp_registered_widgets The registered widgets.
 */
 $wp_registered_widgets = array();
 /**
 * Stores the registered widget controls (options).
 *
-* @global array $wp_registered_widget_controls
 * @since 2.2.0
+*
+* @global array $wp_registered_widget_controls The registered widget controls.
 */
 $wp_registered_widget_controls = array();
-/**
-* @global array $wp_registered_widget_updates
+/**
+* Stores the registered widget updates.
+*
+* @since 2.8.0
+*
+* @global array $wp_registered_widget_updates The registered widget updates.
 */
 $wp_registered_widget_updates = array();
 /**
 * Private
 			}
 		} else {
 			$_args['name'] = isset( $args['name'] ) ? $args['name'] : __( 'Sidebar' );
 		}
-		// Custom specified ID's are suffixed if they exist already.
+		/*
-		// Automatically generated sidebar names need to be suffixed regardless starting at -0.
+		 * Custom specified ID's are suffixed if they exist already.
+		 * Automatically generated sidebar names need to be suffixed regardless starting at -0.
+		 */
 		if ( isset( $args['id'] ) ) {
 			$_args['id'] = $args['id'];
 			$n           = 2; // Start at -2 for conflicting custom IDs.
 			while ( is_registered_sidebar( $_args['id'] ) ) {
 				$_args['id'] = $args['id'] . '-' . $n++;
 *
 * @since 2.2.0
 * @since 5.6.0 Added the `before_sidebar` and `after_sidebar` arguments.
 * @since 5.9.0 Added the `show_in_rest` argument.
 *
-* @global array $wp_registered_sidebars Registered sidebars.
+* @global array $wp_registered_sidebars The registered sidebars.
 *
 * @param array|string $args {
 *     Optional. Array or string of arguments for the sidebar being registered.
 *
 *     @type string $name           The name or title of the sidebar displayed in the Widgets
 /**
 * Removes a sidebar from the list.
 *
 * @since 2.2.0
 *
-* @global array $wp_registered_sidebars Registered sidebars.
+* @global array $wp_registered_sidebars The registered sidebars.
 *
 * @param string|int $sidebar_id The ID of the sidebar when it was registered.
 */
 function unregister_sidebar( $sidebar_id ) {
 	global $wp_registered_sidebars;
 /**
 * Checks if a sidebar is registered.
 *
 * @since 4.4.0
 *
-* @global array $wp_registered_sidebars Registered sidebars.
+* @global array $wp_registered_sidebars The registered sidebars.
 *
 * @param string|int $sidebar_id The ID of the sidebar when it was registered.
 * @return bool True if the sidebar is registered, false otherwise.
 */
 function is_registered_sidebar( $sidebar_id ) {
 *              by adding it to the function signature.
 * @since 5.8.0 Added show_instance_in_rest option.
 *
 * @global array $wp_registered_widgets            Uses stored registered widgets.
 * @global array $wp_registered_widget_controls    Stores the registered widget controls (options).
-* @global array $wp_registered_widget_updates
+* @global array $wp_registered_widget_updates     The registered widget updates.
 * @global array $_wp_deprecated_widgets_callbacks
 *
 * @param int|string $id              Widget ID.
 * @param string     $name            Widget display title.
 * @param callable   $output_callback Run when widget is called.
 * describes the widget for display on the widget administration panel or
 * in the theme.
 *
 * @since 2.5.0
 *
-* @global array $wp_registered_widgets
+* @global array $wp_registered_widgets The registered widgets.
 *
 * @param int|string $id Widget ID.
 * @return string|void Widget description, if available.
 */
 function wp_widget_description( $id ) {
 * When registering sidebars a 'description' parameter can be included that
 * describes the sidebar for display on the widget administration panel.
 *
 * @since 2.9.0
 *
-* @global array $wp_registered_sidebars Registered sidebars.
+* @global array $wp_registered_sidebars The registered sidebars.
 *
 * @param string $id sidebar ID.
 * @return string|void Sidebar description, if available.
 */
 function wp_sidebar_description( $id ) {
 *
 * @since 2.2.0
 * @since 5.3.0 Formalized the existing and already documented `...$params` parameter
 *              by adding it to the function signature.
 *
-* @global array $wp_registered_widget_controls
+* @global array $wp_registered_widget_controls The registered widget controls.
-* @global array $wp_registered_widget_updates
+* @global array $wp_registered_widget_updates  The registered widget updates.
-* @global array $wp_registered_widgets
+* @global array $wp_registered_widgets         The registered widgets.
 * @global array $_wp_deprecated_widgets_callbacks
 *
 * @param int|string $id               Sidebar ID.
 * @param string     $name             Sidebar display name.
 * @param callable   $control_callback Run when sidebar is displayed.
 *
 * @since 2.8.0
 * @since 5.3.0 Formalized the existing and already documented `...$params` parameter
 *              by adding it to the function signature.
 *
-* @global array $wp_registered_widget_updates
+* @global array $wp_registered_widget_updates The registered widget updates.
 *
 * @param string   $id_base         The base ID of a widget created by extending WP_Widget.
 * @param callable $update_callback Update callback method for the widget.
 * @param array    $options         Optional. Widget control options. See wp_register_widget_control().
 *                                  Default empty array.
 *
 * @since 2.8.0
 * @since 5.3.0 Formalized the existing and already documented `...$params` parameter
 *              by adding it to the function signature.
 *
-* @global array $wp_registered_widget_controls
+* @global array $wp_registered_widget_controls The registered widget controls.
 *
 * @param int|string $id            Widget ID.
 * @param string     $name          Name attribute for the widget.
 * @param callable   $form_callback Form callback.
 * @param array      $options       Optional. Widget control options. See wp_register_widget_control().
 * 'name' parameter for its registered sidebars you can pass an ID or name as the $index parameter.
 * Otherwise, you can pass in a numerical index to display the sidebar at that index.
 *
 * @since 2.2.0
 *
-* @global array $wp_registered_sidebars Registered sidebars.
+* @global array $wp_registered_sidebars The registered sidebars.
-* @global array $wp_registered_widgets  Registered widgets.
+* @global array $wp_registered_widgets  The registered widgets.
 *
 * @param int|string $index Optional. Index, name or ID of dynamic sidebar. Default 1.
 * @return bool True, if widget sidebar was found and called. False if not found or not called.
 */
 function dynamic_sidebar( $index = 1 ) {
 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
 * Conditional Tags} article in the Theme Developer Handbook.
 *
 * @since 2.2.0
 *
-* @global array $wp_registered_widgets
+* @global array $wp_registered_widgets The registered widgets.
 *
 * @param callable|false $callback      Optional. Widget callback to check. Default false.
 * @param string|false   $widget_id     Optional. Widget ID. Optional, but needed for checking.
 *                                      Default false.
 * @param string|false   $id_base       Optional. The base ID of a widget created by extending WP_Widget.
 	$sidebars_widgets = wp_get_sidebars_widgets();
 	if ( is_array( $sidebars_widgets ) ) {
 		foreach ( $sidebars_widgets as $sidebar => $widgets ) {
-			if ( $skip_inactive && ( 'wp_inactive_widgets' === $sidebar || 'orphaned_widgets' === substr( $sidebar, 0, 16 ) ) ) {
+			if ( $skip_inactive && ( 'wp_inactive_widgets' === $sidebar || str_starts_with( $sidebar, 'orphaned_widgets' ) ) ) {
 				continue;
 			}
 			if ( is_array( $widgets ) ) {
 				foreach ( $widgets as $widget ) {
 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
 * Conditional Tags} article in the Theme Developer Handbook.
 *
 * @since 2.2.0
 *
-* @global array $wp_registered_widgets  Registered widgets.
+* @global array $wp_registered_widgets  The registered widgets.
-* @global array $wp_registered_sidebars Registered sidebars.
+* @global array $wp_registered_sidebars The registered sidebars.
 *
 * @return bool True if using widgets, false otherwise.
 */
 function is_dynamic_sidebar() {
 	global $wp_registered_widgets, $wp_registered_sidebars;
 		_deprecated_argument( __FUNCTION__, '2.8.1' );
 	}
 	global $_wp_sidebars_widgets, $sidebars_widgets;
-	// If loading from front page, consult $_wp_sidebars_widgets rather than options
+	/*
-	// to see if wp_convert_widget_settings() has made manipulations in memory.
+	 * If loading from front page, consult $_wp_sidebars_widgets rather than options
+	 * to see if wp_convert_widget_settings() has made manipulations in memory.
+	 */
 	if ( ! is_admin() ) {
 		if ( empty( $_wp_sidebars_widgets ) ) {
 			$_wp_sidebars_widgets = get_option( 'sidebars_widgets', array() );
 		}
 * Retrieve default registered sidebars list.
 *
 * @since 2.2.0
 * @access private
 *
-* @global array $wp_registered_sidebars Registered sidebars.
+* @global array $wp_registered_sidebars The registered sidebars.
 *
 * @return array
 */
 function wp_get_widget_defaults() {
 	global $wp_registered_sidebars;
 * and the global `$sidebars_widgets`. For that reason it should not be run on front end,
 * unless the `$theme_changed` value is 'customize' (to bypass the database write).
 *
 * @since 2.8.0
 *
-* @global array $wp_registered_sidebars Registered sidebars.
+* @global array $wp_registered_sidebars The registered sidebars.
 * @global array $sidebars_widgets
-* @global array $wp_registered_widgets  Registered widgets.
+* @global array $wp_registered_widgets  The registered widgets.
 *
 * @param string|bool $theme_changed Whether the theme was changed as a boolean. A value
 *                                   of 'customize' defers updates for the Customizer.
 * @return array Updated sidebars widgets.
 */
 * Compares a list of sidebars with their widgets against an allowed list.
 *
 * @since 4.9.0
 * @since 4.9.2 Always tries to restore widget assignments from previous data, not just if sidebars needed mapping.
 *
+* @global array $wp_registered_sidebars The registered sidebars.
+*
 * @param array $existing_sidebars_widgets List of sidebars and their widget instance IDs.
 * @return array Mapped sidebars widgets.
 */
 function wp_map_sidebars_widgets( $existing_sidebars_widgets ) {
 	global $wp_registered_sidebars;
 	if ( ! is_array( $existing_sidebars_widgets ) || empty( $existing_sidebars_widgets ) ) {
 		return $new_sidebars_widgets;
 	}
 	foreach ( $existing_sidebars_widgets as $sidebar => $widgets ) {
-		if ( 'wp_inactive_widgets' === $sidebar || 'orphaned_widgets' === substr( $sidebar, 0, 16 ) ) {
+		if ( 'wp_inactive_widgets' === $sidebar || str_starts_with( $sidebar, 'orphaned_widgets' ) ) {
 			$new_sidebars_widgets['wp_inactive_widgets'] = array_merge( $new_sidebars_widgets['wp_inactive_widgets'], (array) $widgets );
 			unset( $existing_sidebars_widgets[ $sidebar ] );
 		}
 	}
 			}
 		}
 		// Remove orphaned widgets, we're only interested in previously active sidebars.
 		foreach ( $old_sidebars_widgets as $sidebar => $widgets ) {
-			if ( 'orphaned_widgets' === substr( $sidebar, 0, 16 ) ) {
+			if ( str_starts_with( $sidebar, 'orphaned_widgets' ) ) {
 				unset( $old_sidebars_widgets[ $sidebar ] );
 			}
 		}
 		$old_sidebars_widgets = _wp_remove_unregistered_widgets( $old_sidebars_widgets );
 /**
 * Compares a list of sidebars with their widgets against an allowed list.
 *
 * @since 4.9.0
 *
+* @global array $wp_registered_widgets The registered widgets.
+*
 * @param array $sidebars_widgets   List of sidebars and their widget instance IDs.
 * @param array $allowed_widget_ids Optional. List of widget IDs to compare against. Default: Registered widgets.
 * @return array Sidebars with allowed widgets.
 */
 function _wp_remove_unregistered_widgets( $sidebars_widgets, $allowed_widget_ids = array() ) {
 		return;
 	}
 	if ( is_wp_error( $rss ) ) {
 		if ( is_admin() || current_user_can( 'manage_options' ) ) {
-			echo '<p><strong>' . __( 'RSS Error:' ) . '</strong> ' . $rss->get_error_message() . '</p>';
+			echo '<p><strong>' . __( 'RSS Error:' ) . '</strong> ' . esc_html( $rss->get_error_message() ) . '</p>';
 		}
 		return;
 	}
 	$default_args = array(
 		$summary = '';
 		if ( $show_summary ) {
 			$summary = $desc;
 			// Change existing [...] to [&hellip;].
-			if ( '[...]' === substr( $summary, -5 ) ) {
+			if ( str_ends_with( $summary, '[...]' ) ) {
 				$summary = substr( $summary, 0, -5 ) . '[&hellip;]';
 			}
 			$summary = '<div class="rssSummary">' . esc_html( $summary ) . '</div>';
 		}
 	$args['show_summary'] = isset( $args['show_summary'] ) ? (int) $args['show_summary'] : (int) $inputs['show_summary'];
 	$args['show_author']  = isset( $args['show_author'] ) ? (int) $args['show_author'] : (int) $inputs['show_author'];
 	$args['show_date']    = isset( $args['show_date'] ) ? (int) $args['show_date'] : (int) $inputs['show_date'];
 	if ( ! empty( $args['error'] ) ) {
-		echo '<p class="widget-error"><strong>' . __( 'RSS Error:' ) . '</strong> ' . $args['error'] . '</p>';
+		echo '<p class="widget-error"><strong>' . __( 'RSS Error:' ) . '</strong> ' . esc_html( $args['error'] ) . '</p>';
 	}
 	$esc_number = esc_attr( $args['number'] );
 	if ( $inputs['url'] ) :
 		?>
 function wp_widget_rss_process( $widget_rss, $check_feed = true ) {
 	$items = (int) $widget_rss['items'];
 	if ( $items < 1 || 20 < $items ) {
 		$items = 10;
 	}
-	$url          = esc_url_raw( strip_tags( $widget_rss['url'] ) );
+	$url          = sanitize_url( strip_tags( $widget_rss['url'] ) );
 	$title        = isset( $widget_rss['title'] ) ? trim( strip_tags( $widget_rss['title'] ) ) : '';
 	$show_summary = isset( $widget_rss['show_summary'] ) ? (int) $widget_rss['show_summary'] : 0;
 	$show_author  = isset( $widget_rss['show_author'] ) ? (int) $widget_rss['show_author'] : 0;
 	$show_date    = isset( $widget_rss['show_date'] ) ? (int) $widget_rss['show_date'] : 0;
 	$error        = false;
 /**
 * Calls the render callback of a widget and returns the output.
 *
 * @since 5.8.0
+*
+* @global array $wp_registered_widgets  The registered widgets.
+* @global array $wp_registered_sidebars The registered sidebars.
 *
 * @param string $widget_id Widget ID.
 * @param string $sidebar_id Sidebar ID.
 * @return string
 */
 /**
 * Calls the control callback of a widget and returns the output.
 *
 * @since 5.8.0
+*
+* @global array $wp_registered_widget_controls The registered widget controls.
 *
 * @param string $id Widget ID.
 * @return string|null
 */
 function wp_render_widget_control( $id ) {
 				'5.8.0'
 			);
 		}
 	}
 }
+/**
+* Registers the previous theme's sidebars for the block themes.
+*
+* @since 6.2.0
+* @access private
+*
+* @global array $wp_registered_sidebars The registered sidebars.
+*/
+function _wp_block_theme_register_classic_sidebars() {
+	global $wp_registered_sidebars;
+	if ( ! wp_is_block_theme() ) {
+		return;
+	}
+	$classic_sidebars = get_theme_mod( 'wp_classic_sidebars' );
+	if ( empty( $classic_sidebars ) ) {
+		return;
+	}
+	// Don't use `register_sidebar` since it will enable the `widgets` support for a theme.
+	foreach ( $classic_sidebars as $sidebar ) {
+		$wp_registered_sidebars[ $sidebar['id'] ] = $sidebar;
+	}
+}

changeset 21	48c4eec2b7e6
parent 19	3d72ae0968f4
child 22	8c2e4d02f4ef