Changeset 51142

Timestamp:

06/14/2021 03:15:26 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Update documentation for some WP_Customize_Widgets methods per the documentation standards.

• Add missing @since tags for the $id_base parameter of ::sanitize_widget_instance() and ::sanitize_widget_js_instance()`.
• Document the usage of $wp_widget_factory global in ::sanitize_widget_instance().
• Use multi-line comment syntax for a comment in ::enqueue_scripts().

Follow-up to [50996], [51141].

See #52628.

File:

• trunk/src/wp-includes/class-wp-customize-widgets.php (modified) (3 diffs)

trunk/src/wp-includes/class-wp-customize-widgets.php

@@ -829 +829 @@
         );
 
-        // TODO: Update 'wp-customize-widgets' to not rely so much on things in
-        // 'customize-widgets'. This will let us skip most of the above and not
-        // enqueue 'customize-widgets' which saves bytes.
+        /*
+         * TODO: Update 'wp-customize-widgets' to not rely so much on things in
+         * 'customize-widgets'. This will let us skip most of the above and not
+         * enqueue 'customize-widgets' which saves bytes.
+         */
 
         if ( wp_use_widgets_block_editor() ) {
@@ -1395 +1397 @@
      *
      * @since 3.9.0
+     * @since 5.8.0 Added the `$id_base` parameter.
      *
      * @global WP_Widget_Factory $wp_widget_factory
      *
-     * @param array $value Widget instance to sanitize.
-     * @param string $id_base Base of the ID of the widget being sanitized.
+     * @param array  $value   Widget instance to sanitize.
+     * @param string $id_base Optional. Base of the ID of the widget being sanitized. Default null.
      * @return array|void Sanitized widget instance.
      */
@@ -1445 +1448 @@
      *
      * @since 3.9.0
-     *
-     * @param array $value Widget instance to convert to JSON.
-     * @param string $id_base Base of the ID of the widget being sanitized.
+     * @since 5.8.0 Added the `$id_base` parameter.
+     *
+     * @global WP_Widget_Factory $wp_widget_factory
+     *
+     * @param array  $value   Widget instance to convert to JSON.
+     * @param string $id_base Optional. Base of the ID of the widget being sanitized. Default null.
      * @return array JSON-converted widget instance.
      */