Changeset 51322 for trunk/src/wp-content/themes/twentytwenty/classes/class-twentytwenty-customize.php

Timestamp:

07/03/2021 09:13:48 AM (3 years ago)

Author:

SergeyBiryukov

Message:

Twenty Twenty: Add missing documentation for some filters.

Add missing @since tags for some functions.

Correct alignment of some @param tags.

Follow-up to [46271], [46278], [51304].

See #52628, #53461.

File:

• trunk/src/wp-content/themes/twentytwenty/classes/class-twentytwenty-customize.php (modified) (9 diffs)

trunk/src/wp-content/themes/twentytwenty/classes/class-twentytwenty-customize.php

@@ -11 +11 @@
     /**
      * CUSTOMIZER SETTINGS
+     *
+     * @since Twenty Twenty 1.0
      */
     class TwentyTwenty_Customize {
@@ -16 +18 @@
         /**
          * Register customizer options.
+         *
+         * @since Twenty Twenty 1.0
          *
          * @param WP_Customize_Manager $wp_customize Theme Customizer object.
@@ -413 +417 @@
          * Sanitization callback for the "accent_accessible_colors" setting.
          *
-         * @static
-         * @access public
          * @since Twenty Twenty 1.0
+         *
          * @param array $value The value we want to sanitize.
          * @return array Returns sanitized value. Each item in the array gets sanitized separately.
@@ -437 +440 @@
          * Sanitize select.
          *
-         * @param string $input The input from the setting.
+         * @since Twenty Twenty 1.0
+         *
+         * @param string $input   The input from the setting.
          * @param object $setting The selected setting.
          * @return string The input from the setting or the default setting.
@@ -450 +455 @@
          * Sanitize boolean for checkbox.
          *
+         * @since Twenty Twenty 1.0
+         *
          * @param bool $checked Whether or not a box is checked.
          * @return bool
@@ -470 +477 @@
     /**
      * Render the site title for the selective refresh partial.
+     *
+     * @since Twenty Twenty 1.0
      */
     function twentytwenty_customize_partial_blogname() {
@@ -479 +488 @@
     /**
      * Render the site description for the selective refresh partial.
+     *
+     * @since Twenty Twenty 1.0
      */
     function twentytwenty_customize_partial_blogdescription() {
@@ -490 +501 @@
      *
      * Doing it this way so we don't have issues with `render_callback`'s arguments.
+     *
+     * @since Twenty Twenty 1.0
      */
     function twentytwenty_customize_partial_site_logo() {
@@ -500 +513 @@
  * Input attributes for cover overlay opacity option.
  *
+ * @since Twenty Twenty 1.0
+ *
  * @return array Array containing attribute names and their values.
  */
 function twentytwenty_customize_opacity_range() {
     /**
-     * Filters the input attributes for opacity
+     * Filters the input attributes for opacity.
+     *
+     * @since Twenty Twenty 1.0
      *
      * @param array $attrs {
-     *     The attributes
-     *
-     *     @type int $min Minimum value
-     *     @type int $max Maximum value
-     *     @type int $step Interval between numbers
+     *     The attributes.
+     *
+     *     @type int $min  Minimum value.
+     *     @type int $max  Maximum value.
+     *     @type int $step Interval between numbers.
      * }
      */