Context Navigation

← Previous Changeset
Next Changeset →

Changeset 60537

Timestamp:

08/04/2025 08:53:04 PM (6 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

assets/js/customize-helpers.js (modified) (2 diffs)
assets/js/editor-dark-mode-support.js (modified) (1 diff)
assets/js/primary-navigation.js (modified) (4 diffs)
assets/js/responsive-embeds.js (modified) (1 diff)
classes/class-twenty-twenty-one-custom-colors.php (modified) (4 diffs)
classes/class-twenty-twenty-one-customize-color-control.php (modified) (3 diffs)
classes/class-twenty-twenty-one-customize.php (modified) (5 diffs)
image.php (modified) (1 diff)
inc/back-compat.php (modified) (1 diff)
inc/block-patterns.php (modified) (2 diffs)
inc/block-styles.php (modified) (1 diff)
inc/custom-css.php (modified) (1 diff)
inc/menu-functions.php (modified) (1 diff)
inc/template-functions.php (modified) (5 diffs)
inc/template-tags.php (modified) (1 diff)
template-parts/excerpt/excerpt-aside.php (modified) (1 diff)
template-parts/excerpt/excerpt-audio.php (modified) (1 diff)
template-parts/excerpt/excerpt-chat.php (modified) (1 diff)
template-parts/excerpt/excerpt-gallery.php (modified) (1 diff)
template-parts/excerpt/excerpt-image.php (modified) (1 diff)
template-parts/excerpt/excerpt-link.php (modified) (1 diff)
template-parts/excerpt/excerpt-quote.php (modified) (1 diff)
template-parts/excerpt/excerpt-status.php (modified) (1 diff)
template-parts/excerpt/excerpt-video.php (modified) (1 diff)
template-parts/excerpt/excerpt.php (modified) (1 diff)

Legend:

: Unmodified
: Added
: Removed

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

-                      r51304
+                      r60537
 /**
  * Get luminance from a HEX color.
+ * Gets luminance from a HEX color.
+ *
  * @since Twenty Twenty-One 1.0
 …
 /**
  * Get RGB from HEX.
+ * Gets RGB from HEX.
+ *
  * @since Twenty Twenty-One 1.0

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

r51246	r60537
7	7
8	8	/**
9		* ~~Once the editor loads, add the dark mode clas~~s.
	9	* Adds the dark mode class once the editor loads.
10	10	*
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.
12	12	*
13	13	* @since Twenty Twenty-One 1.0

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

-                      r60352
+                      r60537
 /**
  * Toggle an attribute's value
+ * Toggles an attribute's value
+ *
  * @since Twenty Twenty-One 1.0
 …
 /**
  * Handle clicks on submenu toggles.
+ * Handles clicks on submenu toggles.
+ *
  * @since Twenty Twenty-One 1.0
 …
         /**
          * Trap keyboard navigation in the menu modal.
+         * Traps keyboard navigation in the menu modal.
          * Adapted from Twenty Twenty.
+         *
 …
         /**
          * Close menu and scroll to anchor when an anchor link is clicked.
+         * Closes menu and scrolls to anchor when an anchor link is clicked.
          * Adapted from Twenty Twenty.
+         *

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

r51246	r60537
6	6
7	7	/**
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.
9	9	*
10	10	* @since Twenty Twenty-One 1.0

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

-                      r56300
+                      r60537
     /**
      * Instantiate the object.
+     * Instantiates the object.
+     *
      * @since Twenty Twenty-One 1.0
 …
     /**
      * Determine the luminance of the given color and then return #fff or #000 so that the text is always readable.
+     * Determines the luminance of the given color and then returns #fff or #000 so that the text is always readable.
+     *
      * @since Twenty Twenty-One 1.0
 …
     /**
      * Generate color variables.
+     * Generates color variables.
+     *
      * Adjust the color value of the CSS variables depending on the background color theme mod.
+     * Adjusts the color value of the CSS variables depending on the background color theme mod.
      * Both text and link colors needs to be updated.
      * The code below needs to be updated, because the colors are no longer theme mods.
 …
     /**
      * Get luminance from a HEX color.
+     * Gets luminance from a HEX color.
+     *
      * @static

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

-                      r51294
+                      r60537
     /**
      * Colorpicker palette
+     * Colorpicker palette.
+     *
      * @since Twenty Twenty-One 1.0
 …
     /**
      * Enqueue control related scripts/styles.
+     * Enqueues control related scripts/styles.
+     *
      * @since Twenty Twenty-One 1.0
 …
     /**
      * Refresh the parameters passed to the JavaScript via JSON.
+     * Refreshes the parameters passed to the JavaScript via JSON.
+     *
      * @since Twenty Twenty-One 1.0

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

-                      r56559
+                      r60537
         /**
          * Constructor. Instantiate the object.
+         * Constructor. Instantiates the object.
+         *
          * @since Twenty Twenty-One 1.0
 …
         /**
          * Register customizer options.
+         * Registers customizer options.
+         *
          * @since Twenty Twenty-One 1.0
 …
         /**
          * Sanitize boolean for checkbox.
+         * Sanitizes a boolean for checkbox.
+         *
          * @since Twenty Twenty-One 1.0
 …
         /**
          * Render the site title for the selective refresh partial.
+         * Renders the site title for the selective refresh partial.
+         *
          * @since Twenty Twenty-One 1.0
 …
         /**
          * Render the site tagline for the selective refresh partial.
+         * Renders the site tagline for the selective refresh partial.
+         *
          * @since Twenty Twenty-One 1.0

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

r55276	r60537
23	23	<?php
24	24	/**
25		* Filter the default image attachment size.
	25	* Filters the default image attachment size.
26	26	*
27	27	* @since Twenty Twenty-One 1.0

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

r49826	r60537
13	13
14	14	/**
15		* Display upgrade notice on theme switch.
	15	* Displays upgrade notice on theme switch.
16	16	*
17	17	* @since Twenty Twenty-One 1.0

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

-                      r56548
+                      r60537
 if ( function_exists( 'register_block_pattern_category' ) ) {
     /**
      * Register Block Pattern Category.
+     * Registers Block Pattern Category.
+     *
      * @since Twenty Twenty-One 1.0
 …
 if ( function_exists( 'register_block_pattern' ) ) {
     /**
      * Register Block Pattern.
+     * Registers Block Pattern.
+     *
      * @since Twenty Twenty-One 1.0

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

r49826	r60537
12	12	if ( function_exists( 'register_block_style' ) ) {
13	13	/**
14		* Register block styles.
	14	* Registers block styles.
15	15	*
16	16	* @since Twenty Twenty-One 1.0

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

r53284	r60537
9	9
10	10	/**
11		* Generate CSS.
	11	* Generates CSS.
12	12	*
13	13	* @since Twenty Twenty-One 1.0

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

r58293	r60537
14	14
15	15	/**
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.
17	17	* An icon is added using CSS depending on the value of aria-expanded.
18	18	*

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

-                      r57277
+                      r60537
 /**
  * Add a pingback url auto-discovery header for single posts, pages, or attachments.
+ * Adds a pingback url auto-discovery header for single posts, pages, or attachments.
+ *
  * @since Twenty Twenty-One 1.0
 …
 /**
  * Remove the `no-js` class from body if JS is supported.
+ * Removes the `no-js` class from body if JS is supported.
+ *
  * @since Twenty Twenty-One 1.0
 …
 /**
  * Get custom CSS.
+ * Gets custom CSS.
+ *
  * Return CSS for non-latin language, if available, or null
 …
 /**
  * Print the first instance of a block in the content, and then break away.
+ * Prints the first instance of a block in the content, and then break away.
+ *
  * @since Twenty Twenty-One 1.0
 …
 /**
  * Retrieve protected post password form content.
+ * Retrieves protected post password form content.
+ *
  * @since Twenty Twenty-One 1.0

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

r57991	r60537
213	213	if ( ! function_exists( 'twenty_twenty_one_the_posts_navigation' ) ) {
214	214	/**
215		* Print the next and previous posts navigation.
	215	* Prints the next and previous posts navigation.
216	216	*
217	217	* @since Twenty Twenty-One 1.0

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

r49826	r60537
1	1	<?php
2	2	/**
3		* Show the appropriate content for the Aside post format.
	3	* Shows the appropriate content for the Aside post format.
4	4	*
5	5	* @link https://developer.wordpress.org/themes/basics/template-hierarchy/

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

r49826	r60537
1	1	<?php
2	2	/**
3		* Show the appropriate content for the Audio post format.
	3	* Shows the appropriate content for the Audio post format.
4	4	*
5	5	* @link https://developer.wordpress.org/themes/basics/template-hierarchy/

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

r49826	r60537
1	1	<?php
2	2	/**
3		* Show the appropriate content for the Chat post format.
	3	* Shows the appropriate content for the Chat post format.
4	4	*
5	5	* @link https://developer.wordpress.org/themes/basics/template-hierarchy/

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

r49826	r60537
1	1	<?php
2	2	/**
3		* Show the appropriate content for the Gallery post format.
	3	* Shows the appropriate content for the Gallery post format.
4	4	*
5	5	* @link https://developer.wordpress.org/themes/basics/template-hierarchy/

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

r49826	r60537
1	1	<?php
2	2	/**
3		* Show the appropriate content for the Image post format.
	3	* Shows the appropriate content for the Image post format.
4	4	*
5	5	* @link https://developer.wordpress.org/themes/basics/template-hierarchy/

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

r49826	r60537
1	1	<?php
2	2	/**
3		* Show the appropriate content for the Link post format.
	3	* Shows the appropriate content for the Link post format.
4	4	*
5	5	* @link https://developer.wordpress.org/themes/basics/template-hierarchy/

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

r49826	r60537
1	1	<?php
2	2	/**
3		* Show the appropriate content for the Quote post format.
	3	* Shows the appropriate content for the Quote post format.
4	4	*
5	5	* @link https://developer.wordpress.org/themes/basics/template-hierarchy/

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

r49826	r60537
1	1	<?php
2	2	/**
3		* Show the appropriate content for the Status post format.
	3	* Shows the appropriate content for the Status post format.
4	4	*
5	5	* @link https://developer.wordpress.org/themes/basics/template-hierarchy/

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

r49826	r60537
1	1	<?php
2	2	/**
3		* Show the appropriate content for the Video post format.
	3	* Shows the appropriate content for the Video post format.
4	4	*
5	5	* @link https://developer.wordpress.org/themes/basics/template-hierarchy/

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

r49826	r60537
1	1	<?php
2	2	/**
3		* Show the excerpt.
	3	* Shows the excerpt.
4	4	*
5	5	* @link https://developer.wordpress.org/themes/basics/template-hierarchy/

Note: See TracChangeset for help on using the changeset viewer.

Trac UI Preferences

Make WordPress Core