Changeset 60519

Timestamp:

07/28/2025 07:16:52 PM (7 months ago)

Author:

SergeyBiryukov

Message:

Twenty Fourteen: 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/twentyfourteen

Files:

• functions.php (modified) (15 diffs)
• inc/back-compat.php (modified) (4 diffs)
• inc/custom-header.php (modified) (6 diffs)
• inc/customizer.php (modified) (6 diffs)
• inc/featured-content.php (modified) (16 diffs)
• inc/template-tags.php (modified) (7 diffs)
• inc/widgets.php (modified) (4 diffs)
• js/functions.js (modified) (1 diff)

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

@@ -3 +3 @@
  * Twenty Fourteen 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.
@@ -224 +224 @@
 
 /**
- * Adjust content_width value for image attachment template.
+ * Adjusts content_width value for image attachment template.
  *
  * @since Twenty Fourteen 1.0
@@ -265 +265 @@
 
 /**
- * Register three Twenty Fourteen widget areas.
+ * Registers three Twenty Fourteen widget areas.
  *
  * @since Twenty Fourteen 1.0
@@ -311 +311 @@
 if ( ! function_exists( 'twentyfourteen_font_url' ) ) :
     /**
-     * Register Lato font for Twenty Fourteen.
+     * Registers Lato font for Twenty Fourteen.
      *
      * @since Twenty Fourteen 1.0
@@ -333 +333 @@
 
 /**
- * Enqueue scripts and styles for the front end.
+ * Enqueues scripts and styles for the front end.
  *
  * @since Twenty Fourteen 1.0
@@ -402 +402 @@
 
 /**
- * Enqueue font stylesheet to admin screen for custom header display.
+ * Enqueues font stylesheet to admin screen for custom header display.
  *
  * @since Twenty Fourteen 1.0
@@ -413 +413 @@
 
 /**
- * Add preconnect for Google Fonts.
+ * Adds preconnect for Google Fonts.
  *
  * @since Twenty Fourteen 1.9
@@ -439 +439 @@
 
 /**
- * Enqueue styles for the block-based editor.
+ * Enqueues styles for the block-based editor.
  *
  * @since Twenty Fourteen 2.3
@@ -454 +454 @@
 if ( ! function_exists( 'twentyfourteen_the_attached_image' ) ) :
     /**
-     * Print the attached image with a link to the next attached image.
+     * Prints the attached image with a link to the next attached image.
      *
      * @since Twenty Fourteen 1.0
@@ -522 +522 @@
 if ( ! function_exists( 'twentyfourteen_list_authors' ) ) :
     /**
-     * Print a list of all site contributors who published at least one post.
+     * Prints a list of all site contributors who published at least one post.
      *
      * @since Twenty Fourteen 1.0
@@ -584 +584 @@
 
 /**
- * Extend the default WordPress body classes.
+ * Extends the default WordPress body classes.
  *
  * Adds body classes to denote:
@@ -641 +641 @@
 
 /**
- * Extend the default WordPress post classes.
+ * Extends the default WordPress post classes.
  *
  * Adds a post class to denote:
@@ -661 +661 @@
 
 /**
- * Create a nicely formatted and more specific title element text for output
+ * Creates a nicely formatted and more specific title element text for output
  * in head of document, based on current view.
  *
@@ -730 +730 @@
 
 /**
- * Register block patterns and pattern categories.
+ * Registers block patterns and pattern categories.
  *
  * @since Twenty Fourteen 4.1
@@ -751 +751 @@
 
 /**
- * Add an `is_customize_preview` function if it is missing.
+ * Adds an `is_customize_preview` function if it is missing.
  *
  * Enables installing Twenty Fourteen in WordPress versions before 4.0.0 when the

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

@@ -13 +13 @@
 
 /**
- * Prevent switching to Twenty Fourteen on old versions of WordPress.
+ * Prevents switching to Twenty Fourteen 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 3.6.
+ * Prevents the Customizer from being loaded on WordPress versions prior to 3.6.
  *
  * @since Twenty Fourteen 1.0
@@ -66 +66 @@
 
 /**
- * Prevent the Theme Preview from being loaded on WordPress versions prior to 3.4.
+ * Prevents the Theme Preview from being loaded on WordPress versions prior to 3.4.
  *
  * @since Twenty Fourteen 1.0

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

@@ -1 +1 @@
 <?php
 /**
- * Implement Custom Header functionality for Twenty Fourteen
+ * Implements Custom Header functionality for Twenty Fourteen
  *
  * @package WordPress
@@ -9 +9 @@
 
 /**
- * Set up the WordPress core custom header settings.
+ * Sets up the WordPress core custom header settings.
  *
  * @since Twenty Fourteen 1.0
@@ -56 +56 @@
 if ( ! function_exists( 'twentyfourteen_header_style' ) ) :
     /**
-     * Styles the header image and text displayed on the blog
+     * Styles the header image and text displayed on the blog.
      *
      * @see twentyfourteen_custom_header_setup().
@@ -96 +96 @@
 if ( ! function_exists( 'twentyfourteen_admin_header_style' ) ) :
     /**
-     * Style the header image displayed on the Appearance > Header screen.
+     * Styles the header image displayed on the Appearance > Header screen.
      *
      * @see twentyfourteen_custom_header_setup()
@@ -134 +134 @@
 if ( ! function_exists( 'twentyfourteen_admin_header_image' ) ) :
     /**
-     * Create the custom header image markup displayed on the Appearance > Header screen.
+     * Creates the custom header image markup displayed on the Appearance > Header screen.
      *
      * @see twentyfourteen_custom_header_setup()
@@ -155 +155 @@
 if ( ! function_exists( 'twentyfourteen_header_image' ) ) :
     /**
-     * Create the custom header image markup displayed.
+     * Creates the custom header image markup displayed.
      *
      * @see twentyfourteen_custom_header_setup()

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

@@ -9 +9 @@
 
 /**
- * Implement Customizer additions and adjustments.
+ * Implements Customizer additions and adjustments.
  *
  * @since Twenty Fourteen 1.0
@@ -96 +96 @@
 
 /**
- * Render the site title for the selective refresh partial.
+ * Renders the site title for the selective refresh partial.
  *
  * @since Twenty Fourteen 1.7
@@ -109 +109 @@
 
 /**
- * Render the site tagline for the selective refresh partial.
+ * Renders the site tagline for the selective refresh partial.
  *
  * @since Twenty Fourteen 1.7
@@ -122 +122 @@
 
 /**
- * Sanitize the Featured Content layout value.
+ * Sanitizes the Featured Content layout value.
  *
  * @since Twenty Fourteen 1.0
@@ -138 +138 @@
 
 /**
- * Bind JS handlers to make Customizer preview reload changes asynchronously.
+ * Binds JS handlers to make Customizer preview reload changes asynchronously.
  *
  * @since Twenty Fourteen 1.0
@@ -148 +148 @@
 
 /**
- * Add contextual help to the Themes and Post edit screens.
+ * Adds contextual help to the Themes and Post edit screens.
  *
  * @since Twenty Fourteen 1.0

trunk/src/wp-content/themes/twentyfourteen/inc/featured-content.php

@@ -29 +29 @@
 
     /**
-     * Instantiate.
+     * Instantiates.
      *
      * All custom functionality will be hooked into the "init" action.
@@ -40 +40 @@
 
     /**
-     * Conditionally hook into WordPress.
+     * Conditionally hooks into WordPress.
      *
      * Theme must declare that they support this module by adding
@@ -90 +90 @@
 
     /**
-     * Hide "featured" tag from the front end.
+     * Hides "featured" tag from the front end.
      *
      * Has to run on wp_loaded so that the preview filters of the Customizer
@@ -105 +105 @@
 
     /**
-     * Get featured posts.
+     * Gets featured posts.
      *
      * @since Twenty Fourteen 1.0
@@ -130 +130 @@
 
     /**
-     * Get featured post IDs
+     * Gets featured post IDs.
      *
      * This function will return the an array containing the
@@ -180 +180 @@
 
     /**
-     * Return an array with IDs of posts marked as sticky.
+     * Returns an array with IDs of posts marked as sticky.
      *
      * @since Twenty Fourteen 1.0
@@ -191 +191 @@
 
     /**
-     * Delete featured content IDs transient.
+     * Deletes featured content IDs transient.
      *
      * Hooks in the "save_post" action.
@@ -204 +204 @@
 
     /**
-     * Exclude featured posts from the home page blog query.
-     *
-     * Filter the home page posts, and remove any featured post ID's from it.
+     * Excludes featured posts from the home page blog query.
+     *
+     * Filters the home page posts, and removes any featured post ID's from it.
      * Hooked onto the 'pre_get_posts' action, this changes the parameters of
      * the query before it gets any posts.
@@ -246 +246 @@
 
     /**
-     * Reset tag option when the saved tag is deleted.
+     * Resets tag option when the saved tag is deleted.
      *
      * It's important to mention that the transient needs to be deleted,
@@ -273 +273 @@
 
     /**
-     * Hide featured tag from displaying when global terms are queried from the front end.
+     * Hides featured tag from displaying when global terms are queried from the front end.
      *
      * Hooks into the "get_terms" filter.
@@ -319 +319 @@
 
     /**
-     * Hide featured tag from display when terms associated with a post object
+     * Hides featured tag from display when terms associated with a post object
      * are queried from the front end.
      *
@@ -361 +361 @@
 
     /**
-     * Register custom setting on the Settings -> Reading screen.
+     * Registers custom setting on the Settings -> Reading screen.
      *
      * @since Twenty Fourteen 1.0
@@ -370 +370 @@
 
     /**
-     * Add settings to the Customizer.
+     * Adds settings to the Customizer.
      *
      * @since Twenty Fourteen 1.0
@@ -431 +431 @@
 
     /**
-     * Enqueue the tag suggestion script.
+     * Enqueues the tag suggestion script.
      *
      * @since Twenty Fourteen 1.0
@@ -440 +440 @@
 
     /**
-     * Get featured content settings.
-     *
-     * Get all settings recognized by this module. This function
+     * Gets featured content settings.
+     *
+     * Gets all settings recognized by this module. This function
      * will return all settings whether or not they have been stored
      * in the database yet. This ensures that all keys are available
@@ -476 +476 @@
 
     /**
-     * Validate featured content settings.
-     *
-     * Make sure that all user supplied content is in an expected
+     * Validates featured content settings.
+     *
+     * Makes sure that all user supplied content is in an expected
      * format before saving to the database. This function will also
      * delete the transient set in Featured_Content::get_featured_content().

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

@@ -10 +10 @@
 if ( ! function_exists( 'twentyfourteen_paging_nav' ) ) :
     /**
-     * Display navigation to next/previous set of posts when applicable.
+     * Displays navigation to next/previous set of posts when applicable.
      *
      * @since Twenty Fourteen 1.0
@@ -75 +75 @@
 if ( ! function_exists( 'twentyfourteen_post_nav' ) ) :
     /**
-     * Display navigation to next/previous post when applicable.
+     * Displays navigation to next/previous post when applicable.
      *
      * @since Twenty Fourteen 1.0
@@ -113 +113 @@
 if ( ! function_exists( 'twentyfourteen_posted_on' ) ) :
     /**
-     * Print HTML with meta information for the current post-date/time and author.
+     * Prints HTML with meta information for the current post-date/time and author.
      *
      * @since Twenty Fourteen 1.0
@@ -135 +135 @@
 
 /**
- * Find out if blog has more than one category.
+ * Finds out if blog has more than one category.
  *
  * @since Twenty Fourteen 1.0
@@ -167 +167 @@
 
 /**
- * Flush out the transients used in twentyfourteen_categorized_blog.
+ * Flushes out the transients used in twentyfourteen_categorized_blog.
  *
  * @since Twenty Fourteen 1.0
@@ -180 +180 @@
 if ( ! function_exists( 'twentyfourteen_post_thumbnail' ) ) :
     /**
-     * Display an optional post thumbnail.
+     * Displays an optional post thumbnail.
      *
      * Wraps the post thumbnail in an anchor element on index
@@ -247 +247 @@
 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/twentyfourteen/inc/widgets.php

@@ -46 +46 @@
 
     /**
-     * Enqueue scripts.
+     * Enqueues scripts.
      *
      * @since Twenty Fourteen 1.7
@@ -63 +63 @@
 
     /**
-     * Output the HTML for this widget.
+     * Outputs the HTML for this widget.
      *
      * @since Twenty Fourteen 1.0
@@ -257 +257 @@
 
     /**
-     * Deal with the settings when they are saved by the admin.
+     * Deals with the settings when they are saved by the admin.
      *
      * Here is where any validation should happen.
@@ -281 +281 @@
 
     /**
-     * Display the form for this widget on the Widgets page of the Admin area.
+     * Displays the form for this widget on the Widgets page of the Admin area.
      *
      * @since Twenty Fourteen 1.0

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

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