WordPress.org
Get WordPress

Make WordPress Core

Changeset 60537


Ignore:
Timestamp:
08/04/2025 08:53:04 PM (14 months ago)
Author:
SergeyBiryukov
Message:

Twenty Twenty-One: Use third-person singular verbs for function descriptions.

Reference: ​PHP Documentation Standards: Documenting Tips.

Props vladimiraus, mukesh27, SergeyBiryukov.
See #63692.

Location:
trunk/src/wp-content/themes/twentytwentyone
Files:
25 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-content/themes/twentytwentyone/assets/js/customize-helpers.js

    r51304 r60537  
    11/**
    2  * Get luminance from a HEX color.
     2 * Gets luminance from a HEX color.
    33 *
    44 * @since Twenty Twenty-One 1.0
    … …  
    1414
    1515/**
    16  * Get RGB from HEX.
     16 * Gets RGB from HEX.
    1717 *
    1818 * @since Twenty Twenty-One 1.0

  • trunk/src/wp-content/themes/twentytwentyone/assets/js/editor-dark-mode-support.js

    r51246 r60537  
    77
    88/**
    9  * Once the editor loads, add the dark mode class.
     9 * Adds the dark mode class once the editor loads.
    1010 *
    11  * Wait for the editor to load by periodically checking for an element, then we add the classes.
     11 * Waits for the editor to load by periodically checking for an element, then adds the classes.
    1212 *
    1313 * @since Twenty Twenty-One 1.0

  • trunk/src/wp-content/themes/twentytwentyone/assets/js/primary-navigation.js

    r60352 r60537  
    66
    77/**
    8  * Toggle an attribute's value
     8 * Toggles an attribute's value
    99 *
    1010 * @since Twenty Twenty-One 1.0
    … …  
    6767
    6868/**
    69  * Handle clicks on submenu toggles.
     69 * Handles clicks on submenu toggles.
    7070 *
    7171 * @since Twenty Twenty-One 1.0
    … …  
    135135
    136136                /**
    137                  * Trap keyboard navigation in the menu modal.
     137                 * Traps keyboard navigation in the menu modal.
    138138                 * Adapted from Twenty Twenty.
    139139                 *
    … …  
    181181
    182182                /**
    183                  * Close menu and scroll to anchor when an anchor link is clicked.
     183                 * Closes menu and scrolls to anchor when an anchor link is clicked.
    184184                 * Adapted from Twenty Twenty.
    185185                 *

  • trunk/src/wp-content/themes/twentytwentyone/assets/js/responsive-embeds.js

    r51246 r60537  
    66
    77/**
    8  * Add max-width & max-height to <iframe> elements, depending on their width & height props.
     8 * Adds max-width & max-height to <iframe> elements, depending on their width & height props.
    99 *
    1010 * @since Twenty Twenty-One 1.0

  • trunk/src/wp-content/themes/twentytwentyone/classes/class-twenty-twenty-one-custom-colors.php

    r56300 r60537  
    1414
    1515        /**
    16          * Instantiate the object.
     16         * Instantiates the object.
    1717         *
    1818         * @since Twenty Twenty-One 1.0
    … …  
    3131
    3232        /**
    33          * Determine the luminance of the given color and then return #fff or #000 so that the text is always readable.
     33         * Determines the luminance of the given color and then returns #fff or #000 so that the text is always readable.
    3434         *
    3535         * @since Twenty Twenty-One 1.0
    … …  
    4343
    4444        /**
    45          * Generate color variables.
     45         * Generates color variables.
    4646         *
    47          * Adjust the color value of the CSS variables depending on the background color theme mod.
     47         * Adjusts the color value of the CSS variables depending on the background color theme mod.
    4848         * Both text and link colors needs to be updated.
    4949         * The code below needs to be updated, because the colors are no longer theme mods.
    … …  
    112112
    113113        /**
    114          * Get luminance from a HEX color.
     114         * Gets luminance from a HEX color.
    115115         *
    116116         * @static

  • trunk/src/wp-content/themes/twentytwentyone/classes/class-twenty-twenty-one-customize-color-control.php

    r51294 r60537  
    2626
    2727        /**
    28          * Colorpicker palette
     28         * Colorpicker palette.
    2929         *
    3030         * @since Twenty Twenty-One 1.0
    … …  
    3535
    3636        /**
    37          * Enqueue control related scripts/styles.
     37         * Enqueues control related scripts/styles.
    3838         *
    3939         * @since Twenty Twenty-One 1.0
    … …  
    5555
    5656        /**
    57          * Refresh the parameters passed to the JavaScript via JSON.
     57         * Refreshes the parameters passed to the JavaScript via JSON.
    5858         *
    5959         * @since Twenty Twenty-One 1.0

  • trunk/src/wp-content/themes/twentytwentyone/classes/class-twenty-twenty-one-customize.php

    r56559 r60537  
    1717
    1818                /**
    19                  * Constructor. Instantiate the object.
     19                 * Constructor. Instantiates the object.
    2020                 *
    2121                 * @since Twenty Twenty-One 1.0
    … …  
    2626
    2727                /**
    28                  * Register customizer options.
     28                 * Registers customizer options.
    2929                 *
    3030                 * @since Twenty Twenty-One 1.0
    … …  
    145145
    146146                /**
    147                  * Sanitize boolean for checkbox.
     147                 * Sanitizes a boolean for checkbox.
    148148                 *
    149149                 * @since Twenty Twenty-One 1.0
    … …  
    157157
    158158                /**
    159                  * Render the site title for the selective refresh partial.
     159                 * Renders the site title for the selective refresh partial.
    160160                 *
    161161                 * @since Twenty Twenty-One 1.0
    … …  
    168168
    169169                /**
    170                  * Render the site tagline for the selective refresh partial.
     170                 * Renders the site tagline for the selective refresh partial.
    171171                 *
    172172                 * @since Twenty Twenty-One 1.0

  • trunk/src/wp-content/themes/twentytwentyone/image.php

    r55276 r60537  
    2323                                <?php
    2424                                /**
    25                                  * Filter the default image attachment size.
     25                                 * Filters the default image attachment size.
    2626                                 *
    2727                                 * @since Twenty Twenty-One 1.0

  • trunk/src/wp-content/themes/twentytwentyone/inc/back-compat.php

    r49826 r60537  
    1313
    1414/**
    15  * Display upgrade notice on theme switch.
     15 * Displays upgrade notice on theme switch.
    1616 *
    1717 * @since Twenty Twenty-One 1.0

  • trunk/src/wp-content/themes/twentytwentyone/inc/block-patterns.php

    r56548 r60537  
    1313if ( function_exists( 'register_block_pattern_category' ) ) {
    1414        /**
    15          * Register Block Pattern Category.
     15         * Registers Block Pattern Category.
    1616         *
    1717         * @since Twenty Twenty-One 1.0
    … …  
    3333if ( function_exists( 'register_block_pattern' ) ) {
    3434        /**
    35          * Register Block Pattern.
     35         * Registers Block Pattern.
    3636         *
    3737         * @since Twenty Twenty-One 1.0

  • trunk/src/wp-content/themes/twentytwentyone/inc/block-styles.php

    r49826 r60537  
    1212if ( function_exists( 'register_block_style' ) ) {
    1313        /**
    14          * Register block styles.
     14         * Registers block styles.
    1515         *
    1616         * @since Twenty Twenty-One 1.0

  • trunk/src/wp-content/themes/twentytwentyone/inc/custom-css.php

    r53284 r60537  
    99
    1010/**
    11  * Generate CSS.
     11 * Generates CSS.
    1212 *
    1313 * @since Twenty Twenty-One 1.0

  • trunk/src/wp-content/themes/twentytwentyone/inc/menu-functions.php

    r58293 r60537  
    1414
    1515/**
    16  * Add a button to top-level menu items that has sub-menus.
     16 * Adds a button to top-level menu items that has sub-menus.
    1717 * An icon is added using CSS depending on the value of aria-expanded.
    1818 *

  • trunk/src/wp-content/themes/twentytwentyone/inc/template-functions.php

    r57277 r60537  
    5454
    5555/**
    56  * Add a pingback url auto-discovery header for single posts, pages, or attachments.
     56 * Adds a pingback url auto-discovery header for single posts, pages, or attachments.
    5757 *
    5858 * @since Twenty Twenty-One 1.0
    … …  
    6868
    6969/**
    70  * Remove the `no-js` class from body if JS is supported.
     70 * Removes the `no-js` class from body if JS is supported.
    7171 *
    7272 * @since Twenty Twenty-One 1.0
    … …  
    216216
    217217/**
    218  * Get custom CSS.
     218 * Gets custom CSS.
    219219 *
    220220 * Return CSS for non-latin language, if available, or null
    … …  
    344344
    345345/**
    346  * Print the first instance of a block in the content, and then break away.
     346 * Prints the first instance of a block in the content, and then break away.
    347347 *
    348348 * @since Twenty Twenty-One 1.0
    … …  
    407407
    408408/**
    409  * Retrieve protected post password form content.
     409 * Retrieves protected post password form content.
    410410 *
    411411 * @since Twenty Twenty-One 1.0

  • trunk/src/wp-content/themes/twentytwentyone/inc/template-tags.php

    r57991 r60537  
    213213if ( ! function_exists( 'twenty_twenty_one_the_posts_navigation' ) ) {
    214214        /**
    215          * Print the next and previous posts navigation.
     215         * Prints the next and previous posts navigation.
    216216         *
    217217         * @since Twenty Twenty-One 1.0

  • trunk/src/wp-content/themes/twentytwentyone/template-parts/excerpt/excerpt-aside.php

    r49826 r60537  
    11<?php
    22/**
    3  * Show the appropriate content for the Aside post format.
     3 * Shows the appropriate content for the Aside post format.
    44 *
    55 * @link https://developer.wordpress.org/themes/basics/template-hierarchy/

  • trunk/src/wp-content/themes/twentytwentyone/template-parts/excerpt/excerpt-audio.php

    r49826 r60537  
    11<?php
    22/**
    3  * Show the appropriate content for the Audio post format.
     3 * Shows the appropriate content for the Audio post format.
    44 *
    55 * @link https://developer.wordpress.org/themes/basics/template-hierarchy/

  • trunk/src/wp-content/themes/twentytwentyone/template-parts/excerpt/excerpt-chat.php

    r49826 r60537  
    11<?php
    22/**
    3  * Show the appropriate content for the Chat post format.
     3 * Shows the appropriate content for the Chat post format.
    44 *
    55 * @link https://developer.wordpress.org/themes/basics/template-hierarchy/

  • trunk/src/wp-content/themes/twentytwentyone/template-parts/excerpt/excerpt-gallery.php

    r49826 r60537  
    11<?php
    22/**
    3  * Show the appropriate content for the Gallery post format.
     3 * Shows the appropriate content for the Gallery post format.
    44 *
    55 * @link https://developer.wordpress.org/themes/basics/template-hierarchy/

  • trunk/src/wp-content/themes/twentytwentyone/template-parts/excerpt/excerpt-image.php

    r49826 r60537  
    11<?php
    22/**
    3  * Show the appropriate content for the Image post format.
     3 * Shows the appropriate content for the Image post format.
    44 *
    55 * @link https://developer.wordpress.org/themes/basics/template-hierarchy/

  • trunk/src/wp-content/themes/twentytwentyone/template-parts/excerpt/excerpt-link.php

    r49826 r60537  
    11<?php
    22/**
    3  * Show the appropriate content for the Link post format.
     3 * Shows the appropriate content for the Link post format.
    44 *
    55 * @link https://developer.wordpress.org/themes/basics/template-hierarchy/

  • trunk/src/wp-content/themes/twentytwentyone/template-parts/excerpt/excerpt-quote.php

    r49826 r60537  
    11<?php
    22/**
    3  * Show the appropriate content for the Quote post format.
     3 * Shows the appropriate content for the Quote post format.
    44 *
    55 * @link https://developer.wordpress.org/themes/basics/template-hierarchy/

  • trunk/src/wp-content/themes/twentytwentyone/template-parts/excerpt/excerpt-status.php

    r49826 r60537  
    11<?php
    22/**
    3  * Show the appropriate content for the Status post format.
     3 * Shows the appropriate content for the Status post format.
    44 *
    55 * @link https://developer.wordpress.org/themes/basics/template-hierarchy/

  • trunk/src/wp-content/themes/twentytwentyone/template-parts/excerpt/excerpt-video.php

    r49826 r60537  
    11<?php
    22/**
    3  * Show the appropriate content for the Video post format.
     3 * Shows the appropriate content for the Video post format.
    44 *
    55 * @link https://developer.wordpress.org/themes/basics/template-hierarchy/

  • trunk/src/wp-content/themes/twentytwentyone/template-parts/excerpt/excerpt.php

    r49826 r60537  
    11<?php
    22/**
    3  * Show the excerpt.
     3 * Shows the excerpt.
    44 *
    55 * @link https://developer.wordpress.org/themes/basics/template-hierarchy/
Note: See TracChangeset for help on using the changeset viewer.