Make WordPress Core

Changeset 60535


Ignore:
Timestamp:
08/02/2025 01:26:26 PM (6 months ago)
Author:
SergeyBiryukov
Message:

Twenty Nineteen: 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/twentynineteen
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-content/themes/twentynineteen/functions.php

    r60495 r60535  
    191191
    192192/**
    193  * Register widget area.
     193 * Registers widget area.
    194194 *
    195195 * @link https://developer.wordpress.org/themes/functionality/sidebars/#registering-a-sidebar
     
    236236
    237237/**
    238  * Set the content width in pixels, based on the theme's design and stylesheet.
     238 * Sets the content width in pixels, based on the theme's design and stylesheet.
    239239 *
    240240 * Priority 0 to make it available to lower priority callbacks.
     
    292292
    293293/**
    294  * Fix skip link focus in IE11.
     294 * Fixes skip link focus in IE11.
    295295 *
    296296 * This does not enqueue the script because it is tiny and because it is only for IE11,
     
    312312
    313313/**
    314  * Enqueue supplemental block editor styles.
     314 * Enqueues supplemental block editor styles.
    315315 */
    316316function twentynineteen_editor_customizer_styles() {
     
    327327
    328328/**
    329  * Display custom color CSS in customizer and on frontend.
     329 * Displays custom color CSS in customizer and on frontend.
    330330 */
    331331function twentynineteen_colors_css_wrap() {
     
    387387
    388388/**
    389  * Register block patterns and pattern categories.
     389 * Registers block patterns and pattern categories.
    390390 *
    391391 * @since Twenty Nineteen 3.0
  • trunk/src/wp-content/themes/twentynineteen/inc/back-compat.php

    r51155 r60535  
    1313
    1414/**
    15  * Prevent switching to Twenty Nineteen on old versions of WordPress.
     15 * Prevents switching to Twenty Nineteen on old versions of WordPress.
    1616 *
    1717 * Switches to the default theme.
  • trunk/src/wp-content/themes/twentynineteen/inc/color-patterns.php

    r57712 r60535  
    99
    1010/**
    11  * Generate the CSS for the current primary color.
     11 * Generates the CSS for the current primary color.
    1212 */
    1313function twentynineteen_custom_colors_css() {
  • trunk/src/wp-content/themes/twentynineteen/inc/customizer.php

    r60478 r60535  
    99
    1010/**
    11  * Add postMessage support for site title and description for the Theme Customizer.
     11 * Adds postMessage support for site title and description for the Theme Customizer.
    1212 *
    1313 * @param WP_Customize_Manager $wp_customize Theme Customizer object.
     
    106106
    107107/**
    108  * Render the site title for the selective refresh partial.
     108 * Renders the site title for the selective refresh partial.
    109109 *
    110110 * @return void
     
    115115
    116116/**
    117  * Render the site tagline for the selective refresh partial.
     117 * Renders the site tagline for the selective refresh partial.
    118118 *
    119119 * @return void
     
    124124
    125125/**
    126  * Bind JS handlers to instantly live-preview changes.
     126 * Binds JS handlers to instantly live-preview changes.
    127127 */
    128128function twentynineteen_customize_preview_js() {
     
    132132
    133133/**
    134  * Load dynamic logic for the customizer controls area.
     134 * Loads dynamic logic for the customizer controls area.
    135135 */
    136136function twentynineteen_panels_js() {
     
    140140
    141141/**
    142  * Sanitize custom color choice.
     142 * Sanitizes custom color choice.
    143143 *
    144144 * @param string $choice Whether image filter is active.
  • trunk/src/wp-content/themes/twentynineteen/inc/icon-functions.php

    r59103 r60535  
    3939
    4040/**
    41  * Display SVG icons in social links menu.
     41 * Displays SVG icons in social links menu.
    4242 *
    4343 * @param string   $item_output The menu item's starting HTML output.
     
    6262
    6363/**
    64  * Add a dropdown icon to top-level menu items.
     64 * Adds a dropdown icon to top-level menu items.
    6565 *
    6666 * @param string   $item_output The menu item's starting HTML output.
  • trunk/src/wp-content/themes/twentynineteen/inc/template-tags.php

    r55276 r60535  
    203203if ( ! function_exists( 'twentynineteen_comment_form' ) ) :
    204204    /**
    205      * Documentation for function.
     205     * Displays the comment form.
    206206     */
    207207    function twentynineteen_comment_form( $order ) {
     
    219219if ( ! function_exists( 'twentynineteen_the_posts_navigation' ) ) :
    220220    /**
    221      * Documentation for function.
     221     * Displays the next and previous posts navigation.
    222222     */
    223223    function twentynineteen_the_posts_navigation() {
     
    242242if ( ! function_exists( 'wp_body_open' ) ) :
    243243    /**
    244      * Fire the wp_body_open action.
     244     * Fires the wp_body_open action.
    245245     *
    246246     * Added for backward compatibility to support pre-5.2.0 WordPress versions.
  • trunk/src/wp-content/themes/twentynineteen/js/touch-keyboard-navigation.js

    r55972 r60535  
    4444
    4545    /**
    46      * Add class.
     46     * Adds class to an element.
    4747     *
    4848     * @param {Object} el
     
    5656
    5757    /**
    58      * Delete class.
     58     * Deletes class from an element.
    5959     *
    6060     * @param {Object} el
     
    6666
    6767    /**
    68      * Has class?
     68     * Determines whether an element has the given class.
    6969     *
    7070     * @param {Object} el
     
    8181
    8282    /**
    83      * Toggle Aria Expanded state for screenreaders.
     83     * Toggles Aria Expanded state for screenreaders.
    8484     *
    8585     * @param {Object} ariaItem
     
    100100
    101101    /**
    102      * Open sub-menu.
     102     * Opens sub-menu.
    103103     *
    104104     * @param {Object} currentSubMenu
     
    117117
    118118    /**
    119      * Close sub-menu.
     119     * Closes sub-menu.
    120120     *
    121121     * @param {Object} currentSubMenu
     
    153153
    154154    /**
    155      * Find first ancestor of an element by selector.
     155     * Finds first ancestor of an element by selector.
    156156     *
    157157     * @param {Object} child
     
    182182
    183183    /**
    184      * Remove all off-canvas states.
     184     * Removes all off-canvas states.
    185185     */
    186186    function removeAllFocusStates() {
     
    210210
    211211    /**
    212      * Toggle `focus` class to allow sub-menu access on touch screens.
     212     * Toggles `focus` class to allow sub-menu access on touch screens.
    213213     */
    214214    function toggleSubmenuDisplay() {
Note: See TracChangeset for help on using the changeset viewer.