Changeset 59702

Timestamp:

01/24/2025 09:18:05 PM (4 months ago)

Author:

audrasjb

Message:

Docs: Various Docblock fixes in wp-includes/widgets.php, as per WP Docs standards;

Props ankitpatel1578, sabernhardt.
Fixes #62859.
See #62281.

File:

• trunk/src/wp-includes/widgets.php (modified) (18 diffs)

trunk/src/wp-includes/widgets.php

@@ -4 +4 @@
  *
  * This API is used for creating dynamic sidebar without hardcoding functionality into
- * themes
+ * themes.
  *
  * Includes both internal WordPress routines and theme-use routines.
@@ -104 +104 @@
 
 /**
- * Register a widget
+ * Registers a widget.
  *
  * Registers a WP_Widget widget
@@ -227 +227 @@
  *
  * 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
@@ -362 +362 @@
 
 /**
- * Register an instance of a widget.
+ * Registers an instance of a widget.
  *
  * The default widget option is 'classname' that can be overridden.
@@ -436 +436 @@
 
 /**
- * Retrieve description for widget.
+ * Retrieves description for widget.
  *
  * When registering widgets, the options can also include 'description' that
@@ -462 +462 @@
 
 /**
- * Retrieve description for a sidebar.
+ * Retrieves description for a sidebar.
  *
  * When registering sidebars a 'description' parameter can be included that
@@ -670 +670 @@
 
 /**
- * Remove control callback for widget.
+ * Removes control callback for widget.
  *
  * @since 2.2.0
@@ -681 +681 @@
 
 /**
- * Display dynamic sidebar.
+ * Displays dynamic sidebar.
  *
  * By default this displays the default sidebar or 'sidebar-1'. If your theme specifies the 'id' or
@@ -884 +884 @@
  * Determines whether a given widget is displayed on the front end.
  *
- * Either $callback or $id_base can be used
- * $id_base is the first argument when extending WP_Widget class
+ * Either $callback or $id_base can be used.
+ * $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.
@@ -1003 +1003 @@
 
 /**
- * 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
@@ -1082 +1082 @@
 
 /**
- * Set the sidebar widget option to update sidebars.
+ * Sets the sidebar widget option to update sidebars.
  *
  * @since 2.2.0
@@ -1104 +1104 @@
 
 /**
- * Retrieve default registered sidebars list.
+ * Retrieves default registered sidebars list.
  *
  * @since 2.2.0
@@ -1195 +1195 @@
 
 /**
- * Output an arbitrary widget as a template tag.
+ * Outputs an arbitrary widget as a template tag.
  *
  * @since 2.8.0
@@ -1283 +1283 @@
 
 /**
- * Handle sidebars config after theme change
+ * Handles sidebars config after theme change.
  *
  * @access private
@@ -1576 +1576 @@
 
 /**
- * Display the RSS entries in a list.
+ * Displays the RSS entries in a list.
  *
  * @since 2.5.0
@@ -1683 +1683 @@
 
 /**
- * Display RSS widget options form.
+ * Displays RSS widget options form.
  *
  * The options for what fields are displayed for the RSS form are all booleans
@@ -1764 +1764 @@
 
 /**
- * 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
@@ -1884 +1884 @@
 
 /**
- * Whether or not to use the block editor to manage widgets. Defaults to true
- * unless a theme has removed support for widgets-block-editor or a plugin has
- * filtered the return value of this function.
+ * Determines whether or not to use the block editor to manage widgets.
+ * Defaults to true unless a theme has removed support for widgets-block-editor
+ * or a plugin has filtered the return value of this function.
  *
  * @since 5.8.0