WordPress.org

Make WordPress Core


Ignore:
Timestamp:
07/06/2021 12:34:36 PM (5 months ago)
Author:
desrosj
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].

Props SergeyBiryukov.
Merges [51322] to the 5.8 branch.
See #52628, #53461.

Location:
branches/5.8
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • branches/5.8

  • branches/5.8/src/wp-content/themes/twentytwenty/classes/class-twentytwenty-customize.php

    r48861 r51338  
    1111    /**
    1212     * CUSTOMIZER SETTINGS
     13     *
     14     * @since Twenty Twenty 1.0
    1315     */
    1416    class TwentyTwenty_Customize {
     
    1618        /**
    1719         * Register customizer options.
     20         *
     21         * @since Twenty Twenty 1.0
    1822         *
    1923         * @param WP_Customize_Manager $wp_customize Theme Customizer object.
     
    413417         * Sanitization callback for the "accent_accessible_colors" setting.
    414418         *
    415          * @static
    416          * @access public
    417419         * @since Twenty Twenty 1.0
     420         *
    418421         * @param array $value The value we want to sanitize.
    419422         * @return array Returns sanitized value. Each item in the array gets sanitized separately.
     
    437440         * Sanitize select.
    438441         *
    439          * @param string $input The input from the setting.
     442         * @since Twenty Twenty 1.0
     443         *
     444         * @param string $input   The input from the setting.
    440445         * @param object $setting The selected setting.
    441446         * @return string The input from the setting or the default setting.
     
    450455         * Sanitize boolean for checkbox.
    451456         *
     457         * @since Twenty Twenty 1.0
     458         *
    452459         * @param bool $checked Whether or not a box is checked.
    453460         * @return bool
     
    470477    /**
    471478     * Render the site title for the selective refresh partial.
     479     *
     480     * @since Twenty Twenty 1.0
    472481     */
    473482    function twentytwenty_customize_partial_blogname() {
     
    479488    /**
    480489     * Render the site description for the selective refresh partial.
     490     *
     491     * @since Twenty Twenty 1.0
    481492     */
    482493    function twentytwenty_customize_partial_blogdescription() {
     
    490501     *
    491502     * Doing it this way so we don't have issues with `render_callback`'s arguments.
     503     *
     504     * @since Twenty Twenty 1.0
    492505     */
    493506    function twentytwenty_customize_partial_site_logo() {
     
    500513 * Input attributes for cover overlay opacity option.
    501514 *
     515 * @since Twenty Twenty 1.0
     516 *
    502517 * @return array Array containing attribute names and their values.
    503518 */
    504519function twentytwenty_customize_opacity_range() {
    505520    /**
    506      * Filters the input attributes for opacity
     521     * Filters the input attributes for opacity.
     522     *
     523     * @since Twenty Twenty 1.0
    507524     *
    508525     * @param array $attrs {
    509      *     The attributes
    510      *
    511      *     @type int $min Minimum value
    512      *     @type int $max Maximum value
    513      *     @type int $step Interval between numbers
     526     *     The attributes.
     527     *
     528     *     @type int $min  Minimum value.
     529     *     @type int $max  Maximum value.
     530     *     @type int $step Interval between numbers.
    514531     * }
    515532     */
Note: See TracChangeset for help on using the changeset viewer.