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

Reference: [https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#documenting-tips PHP Documentation Standards: Documenting Tips].

Props vladimiraus, mukesh27, SergeyBiryukov.
See #63692.

git-svn-id: https://develop.svn.wordpress.org/trunk@60519 602fd350-edb4-49c9-b593-d223f7449a82

Author: SergeyBiryukov

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

@@ -2,7 +2,7 @@
 /**
  * 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.
  *
@@ -223,7 +223,7 @@ function twentyfourteen_setup() {
 add_action( 'after_setup_theme', 'twentyfourteen_setup' );
 
 /**
- * Adjust content_width value for image attachment template.
+ * Adjusts content_width value for image attachment template.
  *
  * @since Twenty Fourteen 1.0
  */
@@ -264,7 +264,7 @@ function twentyfourteen_has_featured_posts() {
 }
 
 /**
- * Register three Twenty Fourteen widget areas.
+ * Registers three Twenty Fourteen widget areas.
  *
  * @since Twenty Fourteen 1.0
  */
@@ -310,7 +310,7 @@ function twentyfourteen_widgets_init() {
 
 if ( ! function_exists( 'twentyfourteen_font_url' ) ) :
 	/**
-	 * Register Lato font for Twenty Fourteen.
+	 * Registers Lato font for Twenty Fourteen.
 	 *
 	 * @since Twenty Fourteen 1.0
 	 * @since Twenty Fourteen 3.6 Replaced Google URL with self-hosted fonts.
@@ -332,7 +332,7 @@ function twentyfourteen_font_url() {
 endif;
 
 /**
- * Enqueue scripts and styles for the front end.
+ * Enqueues scripts and styles for the front end.
  *
  * @since Twenty Fourteen 1.0
  */
@@ -401,7 +401,7 @@ function twentyfourteen_scripts() {
 add_action( 'wp_enqueue_scripts', 'twentyfourteen_scripts' );
 
 /**
- * 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
  */
@@ -412,7 +412,7 @@ function twentyfourteen_admin_fonts() {
 add_action( 'admin_print_scripts-appearance_page_custom-header', 'twentyfourteen_admin_fonts' );
 
 /**
- * Add preconnect for Google Fonts.
+ * Adds preconnect for Google Fonts.
  *
  * @since Twenty Fourteen 1.9
  * @deprecated Twenty Fourteen 3.6 Disabled filter because, by default, fonts are self-hosted.
@@ -438,7 +438,7 @@ function twentyfourteen_resource_hints( $urls, $relation_type ) {
 // add_filter( 'wp_resource_hints', 'twentyfourteen_resource_hints', 10, 2 );
 
 /**
- * Enqueue styles for the block-based editor.
+ * Enqueues styles for the block-based editor.
  *
  * @since Twenty Fourteen 2.3
  */
@@ -453,7 +453,7 @@ function twentyfourteen_block_editor_styles() {
 
 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
 	 */
@@ -521,7 +521,7 @@ function twentyfourteen_the_attached_image() {
 
 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
 	 */
@@ -583,7 +583,7 @@ function twentyfourteen_list_authors() {
 endif;
 
 /**
- * Extend the default WordPress body classes.
+ * Extends the default WordPress body classes.
  *
  * Adds body classes to denote:
  * 1. Single or multiple authors.
@@ -640,7 +640,7 @@ function twentyfourteen_body_classes( $classes ) {
 add_filter( 'body_class', 'twentyfourteen_body_classes' );
 
 /**
- * Extend the default WordPress post classes.
+ * Extends the default WordPress post classes.
  *
  * Adds a post class to denote:
  * Non-password protected page with a post thumbnail.
@@ -660,7 +660,7 @@ function twentyfourteen_post_classes( $classes ) {
 add_filter( 'post_class', 'twentyfourteen_post_classes' );
 
 /**
- * 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.
  *
  * @since Twenty Fourteen 1.0
@@ -729,7 +729,7 @@ function twentyfourteen_widget_tag_cloud_args( $args ) {
 require get_template_directory() . '/inc/customizer.php';
 
 /**
- * Register block patterns and pattern categories.
+ * Registers block patterns and pattern categories.
  *
  * @since Twenty Fourteen 4.1
  */
@@ -750,7 +750,7 @@ function twentyfourteen_register_block_patterns() {
 }
 
 /**
- * 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
  * `is_customize_preview` function was introduced.

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

@@ -12,7 +12,7 @@
  */
 
 /**
- * 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.
  *
@@ -26,7 +26,7 @@ function twentyfourteen_switch_theme() {
 add_action( 'after_switch_theme', 'twentyfourteen_switch_theme' );
 
 /**
- * Add message for unsuccessful theme switch.
+ * Adds message for unsuccessful theme switch.
  *
  * Prints an update nag after an unsuccessful attempt to switch to
  * Twenty Fourteen on WordPress versions prior to 3.6.
@@ -45,7 +45,7 @@ function twentyfourteen_upgrade_notice() {
 }
 
 /**
- * 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
  */
@@ -65,7 +65,7 @@ function twentyfourteen_customize() {
 add_action( 'load-customize.php', 'twentyfourteen_customize' );
 
 /**
- * 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
  */

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

@@ -1,14 +1,14 @@
 <?php
 /**
- * Implement Custom Header functionality for Twenty Fourteen
+ * Implements Custom Header functionality for Twenty Fourteen
  *
  * @package WordPress
  * @subpackage Twenty_Fourteen
  * @since Twenty Fourteen 1.0
  */
 
 /**
- * Set up the WordPress core custom header settings.
+ * Sets up the WordPress core custom header settings.
  *
  * @since Twenty Fourteen 1.0
  *
@@ -55,7 +55,7 @@ function twentyfourteen_custom_header_setup() {
 
 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().
 	 */
@@ -95,7 +95,7 @@ function twentyfourteen_header_style() {
 
 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()
 	 *
@@ -133,7 +133,7 @@ function twentyfourteen_admin_header_style() {
 
 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()
 	 *
@@ -154,7 +154,7 @@ function twentyfourteen_admin_header_image() {
 
 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()
 	 *

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

@@ -8,7 +8,7 @@
  */
 
 /**
- * Implement Customizer additions and adjustments.
+ * Implements Customizer additions and adjustments.
  *
  * @since Twenty Fourteen 1.0
  *
@@ -95,7 +95,7 @@ function twentyfourteen_customize_register( $wp_customize ) {
 add_action( 'customize_register', 'twentyfourteen_customize_register' );
 
 /**
- * Render the site title for the selective refresh partial.
+ * Renders the site title for the selective refresh partial.
  *
  * @since Twenty Fourteen 1.7
  *
@@ -108,7 +108,7 @@ function twentyfourteen_customize_partial_blogname() {
 }
 
 /**
- * Render the site tagline for the selective refresh partial.
+ * Renders the site tagline for the selective refresh partial.
  *
  * @since Twenty Fourteen 1.7
  *
@@ -121,7 +121,7 @@ function twentyfourteen_customize_partial_blogdescription() {
 }
 
 /**
- * Sanitize the Featured Content layout value.
+ * Sanitizes the Featured Content layout value.
  *
  * @since Twenty Fourteen 1.0
  *
@@ -137,7 +137,7 @@ function twentyfourteen_sanitize_layout( $layout ) {
 }
 
 /**
- * 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
  */
@@ -147,7 +147,7 @@ function twentyfourteen_customize_preview_js() {
 add_action( 'customize_preview_init', 'twentyfourteen_customize_preview_js' );
 
 /**
- * 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
  */