Changeset 60521

Timestamp:

07/29/2025 12:56:16 PM (4 months ago)

Author:

SergeyBiryukov

Message:

Twenty Fifteen: 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/twentyfifteen

Files:

• functions.php (modified) (10 diffs)
• inc/back-compat.php (modified) (4 diffs)
• inc/custom-header.php (modified) (2 diffs)
• inc/customizer.php (modified) (6 diffs)
• inc/template-tags.php (modified) (6 diffs)
• js/color-scheme-control.js (modified) (1 diff)
• js/functions.js (modified) (1 diff)

trunk/src/wp-content/themes/twentyfifteen/functions.php

@@ -3 +3 @@
  * Twenty Fifteen functions and definitions
  *
- * Set up the theme and provides some helper functions, which are used in the
+ * Sets up the theme and provides some helper functions, which are used in the
  * theme as custom template tags. Others are attached to action and filter
  * hooks in WordPress to change core functionality.
@@ -339 +339 @@
 
 /**
- * Register widget area.
+ * Registers widget area.
  *
  * @since Twenty Fifteen 1.0
@@ -362 +362 @@
 if ( ! function_exists( 'twentyfifteen_fonts_url' ) ) :
     /**
-     * Register fonts for Twenty Fifteen.
+     * Registers fonts for Twenty Fifteen.
      *
      * @since Twenty Fifteen 1.0
@@ -418 +418 @@
 
 /**
- * Enqueue scripts and styles.
+ * Enqueues scripts and styles.
  *
  * @since Twenty Fifteen 1.0
@@ -479 +479 @@
 
 /**
- * Enqueue styles for the block-based editor.
+ * Enqueues styles for the block-based editor.
  *
  * @since Twenty Fifteen 2.1
@@ -494 +494 @@
 
 /**
- * Add preconnect for Google Fonts.
+ * Adds preconnect for Google Fonts.
  *
  * @since Twenty Fifteen 1.7
@@ -520 +520 @@
 
 /**
- * Add featured image as background image to post navigation elements.
+ * Adds featured image as background image to post navigation elements.
  *
  * @since Twenty Fifteen 1.0
@@ -562 +562 @@
 
 /**
- * Display descriptions in main navigation.
+ * Displays descriptions in main navigation.
  *
  * @since Twenty Fifteen 1.0
@@ -582 +582 @@
 
 /**
- * Add a `screen-reader-text` class to the search form's submit button.
+ * Adds a `screen-reader-text` class to the search form's submit button.
  *
  * @since Twenty Fifteen 1.0
@@ -658 +658 @@
 
 /**
- * Register block patterns and pattern categories.
+ * Registers block patterns and pattern categories.
  *
  * @since Twenty Fifteen 3.9

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

@@ -13 +13 @@
 
 /**
- * Prevent switching to Twenty Fifteen on old versions of WordPress.
+ * Prevents switching to Twenty Fifteen on old versions of WordPress.
  *
  * Switches to the default theme.
@@ -27 +27 @@
 
 /**
- * Add message for unsuccessful theme switch.
+ * Adds message for unsuccessful theme switch.
  *
  * Prints an update nag after an unsuccessful attempt to switch to
@@ -46 +46 @@
 
 /**
- * Prevent the Customizer from being loaded on WordPress versions prior to 4.1.
+ * Prevents the Customizer from being loaded on WordPress versions prior to 4.1.
  *
  * @since Twenty Fifteen 1.0
@@ -66 +66 @@
 
 /**
- * Prevent the Theme Preview from being loaded on WordPress versions prior to 4.1.
+ * Prevents the Theme Preview from being loaded on WordPress versions prior to 4.1.
  *
  * @since Twenty Fifteen 1.0

trunk/src/wp-content/themes/twentyfifteen/inc/custom-header.php

@@ -9 +9 @@
 
 /**
- * Set up the WordPress core custom header feature.
+ * Sets up the WordPress core custom header feature.
  *
  * @uses twentyfifteen_header_style()
@@ -48 +48 @@
 
 /**
- * Convert HEX to RGB.
+ * Converts HEX to RGB.
  *
  * @since Twenty Fifteen 1.0

trunk/src/wp-content/themes/twentyfifteen/inc/customizer.php

@@ -9 +9 @@
 
 /**
- * Add postMessage support for site title and description for the Customizer.
+ * Adds postMessage support for site title and description for the Customizer.
  *
  * @since Twenty Fifteen 1.0
@@ -114 +114 @@
 
 /**
- * Render the site title for the selective refresh partial.
+ * Renders the site title for the selective refresh partial.
  *
  * @since Twenty Fifteen 1.5
@@ -127 +127 @@
 
 /**
- * Render the site tagline for the selective refresh partial.
+ * Renders the site tagline for the selective refresh partial.
  *
  * @since Twenty Fifteen 1.5
@@ -140 +140 @@
 
 /**
- * Register color schemes for Twenty Fifteen.
+ * Registers color schemes for Twenty Fifteen.
  *
  * Can be filtered with {@see 'twentyfifteen_color_schemes'}.
@@ -253 +253 @@
 if ( ! function_exists( 'twentyfifteen_get_color_scheme' ) ) :
     /**
-     * Get the current Twenty Fifteen color scheme.
+     * Gets the current Twenty Fifteen color scheme.
      *
      * @since Twenty Fifteen 1.0
@@ -771 +771 @@
 
 /**
- * Output an Underscore template for generating CSS for the color scheme.
+ * Outputs an Underscore template for generating CSS for the color scheme.
  *
  * The template generates the css dynamically for instant display in the Customizer

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

@@ -12 +12 @@
 if ( ! function_exists( 'twentyfifteen_comment_nav' ) ) :
     /**
-     * Display navigation to next/previous comments when applicable.
+     * Displays navigation to next/previous comments when applicable.
      *
      * @since Twenty Fifteen 1.0
@@ -151 +151 @@
 
 /**
- * Determine whether blog/site has more than one category.
+ * Determines whether blog/site has more than one category.
  *
  * @since Twenty Fifteen 1.0
@@ -187 +187 @@
 
 /**
- * Flush out the transients used in {@see twentyfifteen_categorized_blog()}.
+ * Flushes out the transients used in {@see twentyfifteen_categorized_blog()}.
  *
  * @since Twenty Fifteen 1.0
@@ -200 +200 @@
 if ( ! function_exists( 'twentyfifteen_post_thumbnail' ) ) :
     /**
-     * Display an optional post thumbnail.
+     * Displays an optional post thumbnail.
      *
      * Wraps the post thumbnail in an anchor element on index views, or a div
@@ -234 +234 @@
 if ( ! function_exists( 'twentyfifteen_get_link_url' ) ) :
     /**
-     * Return the post URL.
+     * Returns the post URL.
      *
      * Falls back to the post permalink if no URL is found in the post.
@@ -289 +289 @@
 if ( ! function_exists( 'wp_body_open' ) ) :
     /**
-     * Fire the wp_body_open action.
+     * Fires the wp_body_open action.
      *
      * Added for backward compatibility to support pre-5.2.0 WordPress versions.

trunk/src/wp-content/themes/twentyfifteen/js/color-scheme-control.js

@@ -1 +1 @@
 /* global colorScheme, Color */
 /**
- * Add a listener to the Color Scheme control to update other color controls to new values/defaults.
- * Also trigger an update of the Color Scheme CSS when a color is changed.
+ * Adds a listener to the Color Scheme control to update other color controls to new values/defaults.
+ * Also triggers an update of the Color Scheme CSS when a color is changed.
  */
 

trunk/src/wp-content/themes/twentyfifteen/js/functions.js

@@ -93 +93 @@
 
     /**
-     * Add or remove ARIA attributes.
+     * Adds or removes ARIA attributes.
      *
      * Uses jQuery's width() function to determine the size of the window and add