Changeset 60515

Timestamp:

07/27/2025 01:03:38 PM (7 months ago)

Author:

SergeyBiryukov

Message:

Twenty Thirteen: 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/twentythirteen

Files:

• functions.php (modified) (22 diffs)
• inc/back-compat.php (modified) (4 diffs)
• inc/custom-header.php (modified) (6 diffs)
• js/functions.js (modified) (1 diff)

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

@@ -47 +47 @@
 
 /**
- * Register block patterns and pattern categories.
+ * Registers block patterns and pattern categories.
  *
  * @since Twenty Thirteen 4.3
@@ -263 +263 @@
 if ( ! function_exists( 'twentythirteen_fonts_url' ) ) :
     /**
-     * Return the font stylesheet URL, if available.
+     * Returns the font stylesheet URL, if available.
      *
      * The use of Source Sans Pro and Bitter by default is localized. For languages
@@ -307 +307 @@
 
 /**
- * Enqueue scripts and styles for the front end.
+ * Enqueues scripts and styles for the front end.
  *
  * @since Twenty Thirteen 1.0
@@ -357 +357 @@
 
 /**
- * Add preconnect for Google Fonts.
+ * Adds preconnect for Google Fonts.
  *
  * @since Twenty Thirteen 2.1
@@ -383 +383 @@
 
 /**
- * Enqueue styles for the block-based editor.
+ * Enqueues styles for the block-based editor.
  *
  * @since Twenty Thirteen 2.5
@@ -397 +397 @@
 
 /**
- * Filter the page title.
+ * Filters the page title.
  *
  * Creates a nicely formatted and more specific title element text for output
@@ -438 +438 @@
 
 /**
- * Register two widget areas.
+ * Registers two widget areas.
  *
  * @since Twenty Thirteen 1.0
@@ -485 +485 @@
 if ( ! function_exists( 'twentythirteen_paging_nav' ) ) :
     /**
-     * Display navigation to next/previous set of posts when applicable.
+     * Displays navigation to next/previous set of posts when applicable.
      *
      * @since Twenty Thirteen 1.0
@@ -522 +522 @@
 if ( ! function_exists( 'twentythirteen_post_nav' ) ) :
     /**
-     * Display navigation to next/previous post when applicable.
+     * Displays navigation to next/previous post when applicable.
      *
      * @since Twenty Thirteen 1.0
@@ -559 +559 @@
 if ( ! function_exists( 'twentythirteen_entry_meta' ) ) :
     /**
-     * Print HTML with meta information for current post: categories, tags, permalink, author, and date.
+     * Prints HTML with meta information for current post: categories, tags, permalink, author, and date.
      *
      * Create your own twentythirteen_entry_meta() to override in a child theme.
@@ -599 +599 @@
 if ( ! function_exists( 'twentythirteen_entry_date' ) ) :
     /**
-     * Print HTML with date information for current post.
+     * Prints HTML with date information for current post.
      *
      * Create your own twentythirteen_entry_date() to override in a child theme.
@@ -635 +635 @@
 if ( ! function_exists( 'twentythirteen_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 Thirteen 1.0
@@ -701 +701 @@
 
 /**
- * Return the post URL.
+ * Returns the post URL.
  *
  * @uses get_url_in_content() to get the URL in the post meta (if it exists) or
@@ -742 +742 @@
 
 /**
- * Extend the default WordPress body classes.
+ * Extends the default WordPress body classes.
  *
  * Adds body classes to denote:
@@ -772 +772 @@
 
 /**
- * Adjust content_width value for video post formats and attachment templates.
+ * Adjusts content_width value for video post formats and attachment templates.
  *
  * @since Twenty Thirteen 1.0
@@ -790 +790 @@
 
 /**
- * Add postMessage support for site title and description for the Customizer.
+ * Adds postMessage support for site title and description for the Customizer.
  *
  * @since Twenty Thirteen 1.0
@@ -823 +823 @@
 
 /**
- * Render the site title for the selective refresh partial.
+ * Renders the site title for the selective refresh partial.
  *
  * @since Twenty Thirteen 1.9
@@ -836 +836 @@
 
 /**
- * Render the site tagline for the selective refresh partial.
+ * Renders the site tagline for the selective refresh partial.
  *
  * @since Twenty Thirteen 1.9
@@ -849 +849 @@
 
 /**
- * Enqueue JavaScript postMessage handlers for the Customizer.
+ * Enqueues JavaScript postMessage handlers for the Customizer.
  *
  * Binds JavaScript handlers to make the Customizer preview
@@ -904 +904 @@
 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.
@@ -921 +921 @@
 
 /**
- * Register Custom Block Styles
+ * Registers Custom Block Styles.
  *
  * @since Twenty Thirteen 3.4
@@ -928 +928 @@
     function twentythirteen_register_block_styles() {
 
-        /**
-         * Register block style
-         */
         register_block_style(
             'core/button',

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

@@ -13 +13 @@
 
 /**
- * Prevent switching to Twenty Thirteen on old versions of WordPress.
+ * Prevents switching to Twenty Thirteen 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 Thirteen 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 Thirteen 1.0

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

@@ -1 +1 @@
 <?php
 /**
- * Implement a custom header for Twenty Thirteen
+ * Implements a custom header for Twenty Thirteen
  *
  * @link https://codex.wordpress.org/Custom_Headers
@@ -11 +11 @@
 
 /**
- * Set up the WordPress core custom header arguments and settings.
+ * Sets up the WordPress core custom header arguments and settings.
  *
  * @uses add_theme_support() to register support for 3.4 and up.
@@ -66 +66 @@
 
 /**
- * Load our special font CSS files.
+ * Loads our special font CSS files.
  *
  * @since Twenty Thirteen 1.0
@@ -80 +80 @@
 
 /**
- * Style the header text displayed on the blog.
+ * Styles the header text displayed on the blog.
  *
  * get_header_textcolor() options: Hide text (returns 'blank'), or any hex value.
@@ -148 +148 @@
 
 /**
- * Style the header image displayed on the Appearance > Header admin panel.
+ * Styles the header image displayed on the Appearance > Header admin panel.
  *
  * @since Twenty Thirteen 1.0
@@ -213 +213 @@
 
 /**
- * Output markup to be displayed on the Appearance > Header admin panel.
+ * Outputs markup to be displayed on the Appearance > Header admin panel.
  *
  * This callback overrides the default markup displayed there.

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

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