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

equal deleted inserted replaced

-:48c4eec2b7e6
+:8c2e4d02f4ef
 <?php
 /**
 * Core Widgets API
 *
 * This API is used for creating dynamic sidebar without hardcoding functionality into
-* themes
+* themes.
 *
 * 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.
 //
 // Template tags & API functions.
 //
 /**
-* Register a widget
+* Registers a widget.
 *
 * Registers a WP_Widget widget
 *
 * @since 2.8.0
 * @since 4.6.0 Updated the `$widget` parameter to also accept a WP_Widget instance object
 * When allowing for automatic generation of the name and ID parameters, keep
 * in mind that the incrementor for your sidebar can change over time depending
 * on what other plugins and themes are installed.
 *
 * If theme support for 'widgets' has not yet been added when this function is
-* called, it will be automatically enabled through the use of add_theme_support()
+* called, it will be automatically enabled through the use of add_theme_support().
 *
 * @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.
 *
 	return isset( $wp_registered_sidebars[ $sidebar_id ] );
 }
 /**
-* Register an instance of a widget.
+* Registers an instance of a widget.
 *
 * The default widget option is 'classname' that can be overridden.
 *
 * The function can also be used to un-register widgets when `$output_callback`
 * parameter is an empty string.
 		$wp_registered_widgets[ $id ] = $widget;
 	}
 }
 /**
-* Retrieve description for widget.
+* Retrieves description for widget.
 *
 * When registering widgets, the options can also include 'description' that
 * describes the widget for display on the widget administration panel or
 * in the theme.
 *
 		return esc_html( $wp_registered_widgets[ $id ]['description'] );
 	}
 }
 /**
-* Retrieve description for a sidebar.
+* Retrieves description for a sidebar.
 *
 * When registering sidebars a 'description' parameter can be included that
 * describes the sidebar for display on the widget administration panel.
 *
 * @since 2.9.0
 	$wp_registered_widget_controls[ $id ] = $widget;
 }
 /**
-* Remove control callback for widget.
+* Removes control callback for widget.
 *
 * @since 2.2.0
 *
 * @param int|string $id Widget ID.
 */
 function wp_unregister_widget_control( $id ) {
 	wp_register_widget_control( $id, '', '' );
 }
 /**
-* Display dynamic sidebar.
+* Displays dynamic sidebar.
 *
 * By default this displays the default sidebar or 'sidebar-1'. If your theme specifies the 'id' or
 * '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.
 *
 }
 /**
 * Determines whether a given widget is displayed on the front end.
 *
-* Either $callback or $id_base can be used
+* Either $callback or $id_base can be used.
-* $id_base is the first argument when extending WP_Widget class
+* $id_base is the first argument when extending WP_Widget class.
 * Without the optional $widget_id parameter, returns the ID of the first sidebar
 * in which the first instance of the widget with the given callback or $id_base is found.
 * With the $widget_id parameter, returns the ID of the sidebar where
 * the widget with that callback/$id_base AND that ID is found.
 *
 //
 // Internal Functions.
 //
 /**
-* Retrieve full list of sidebars and their widget instance IDs.
+* Retrieves the full list of sidebars and their widget instance IDs.
 *
 * Will upgrade sidebar widget list, if needed. Will also save updated list, if
 * needed.
 *
 * @since 2.2.0
 	return null;
 }
 /**
-* Set the sidebar widget option to update sidebars.
+* Sets the sidebar widget option to update sidebars.
 *
 * @since 2.2.0
 * @access private
 *
 * @global array $_wp_sidebars_widgets
 	update_option( 'sidebars_widgets', $sidebars_widgets );
 }
 /**
-* Retrieve default registered sidebars list.
+* Retrieves default registered sidebars list.
 *
 * @since 2.2.0
 * @access private
 *
 * @global array $wp_registered_sidebars The registered sidebars.
 	return $settings;
 }
 /**
-* Output an arbitrary widget as a template tag.
+* Outputs an arbitrary widget as a template tag.
 *
 * @since 2.8.0
 *
 * @global WP_Widget_Factory $wp_widget_factory
 *
 function _get_widget_id_base( $id ) {
 	return preg_replace( '/-[0-9]+$/', '', $id );
 }
 /**
-* Handle sidebars config after theme change
+* Handles sidebars config after theme change.
 *
 * @access private
 * @since 3.3.0
 *
 * @global array $sidebars_widgets
 	return $sidebars_widgets;
 }
 /**
-* Display the RSS entries in a list.
+* Displays the RSS entries in a list.
 *
 * @since 2.5.0
 *
 * @param string|array|object $rss  RSS url.
 * @param array               $args Widget arguments.
 	$rss->__destruct();
 	unset( $rss );
 }
 /**
-* Display RSS widget options form.
+* Displays RSS widget options form.
 *
 * The options for what fields are displayed for the RSS form are all booleans
 * and are as follows: 'url', 'title', 'items', 'show_summary', 'show_author',
 * 'show_date'.
 *
 		<label for="rss-show-summary-<?php echo $esc_number; ?>"><?php _e( 'Display item content?' ); ?></label><br />
 	<?php endif; if ( $inputs['show_author'] ) : ?>
 		<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'] ); ?> />
 		<label for="rss-show-author-<?php echo $esc_number; ?>"><?php _e( 'Display item author if available?' ); ?></label><br />
 	<?php endif; if ( $inputs['show_date'] ) : ?>
-		<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'] ); ?>/>
+		<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'] ); ?> />
 		<label for="rss-show-date-<?php echo $esc_number; ?>"><?php _e( 'Display item date?' ); ?></label><br />
 	<?php endif; ?>
 	</p>
 	<?php
 	endif; // End of display options.
 	endif;
 	endforeach;
 }
 /**
-* Process RSS feed widget data and optionally retrieve feed items.
+* Processes RSS feed widget data and optionally retrieve feed items.
 *
 * The feed widget can not have more than 20 items or it will reset back to the
 * default, which is 10.
 *
 * The resulting array has the feed title, feed url, feed link (from channel),
 function wp_setup_widgets_block_editor() {
 	add_theme_support( 'widgets-block-editor' );
 }
 /**
-* Whether or not to use the block editor to manage widgets. Defaults to true
+* Determines whether or not to use the block editor to manage widgets.
-* unless a theme has removed support for widgets-block-editor or a plugin has
+* Defaults to true unless a theme has removed support for widgets-block-editor
-* filtered the return value of this function.
+* or a plugin has filtered the return value of this function.
 *
 * @since 5.8.0
 *
 * @return bool Whether to use the block editor to manage widgets.
 */

changeset 22	8c2e4d02f4ef
parent 21	48c4eec2b7e6