Changeset 60533

Timestamp:

08/01/2025 11:27:03 AM (7 months ago)

Author:

SergeyBiryukov

Message:

Twenty Seventeen: 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/twentyseventeen

Files:

• functions.php (modified) (11 diffs)
• inc/back-compat.php (modified) (1 diff)
• inc/color-patterns.php (modified) (1 diff)
• inc/custom-header.php (modified) (2 diffs)
• inc/customizer.php (modified) (9 diffs)
• inc/icon-functions.php (modified) (4 diffs)

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

@@ -245 +245 @@
 
 /**
- * Set the content width in pixels, based on the theme's design and stylesheet.
+ * Sets the content width in pixels, based on the theme's design and stylesheet.
  *
  * Priority 0 to make it available to lower priority callbacks.
@@ -285 +285 @@
 if ( ! function_exists( 'twentyseventeen_fonts_url' ) ) :
     /**
-     * Register custom fonts.
+     * Registers custom fonts.
      *
      * @since Twenty Seventeen 1.0
@@ -310 +310 @@
 
 /**
- * Add preconnect for Google Fonts.
+ * Adds preconnect for Google Fonts.
  *
  * @since Twenty Seventeen 1.0
@@ -332 +332 @@
 
 /**
- * Register widget area.
+ * Registers widget area.
  *
  * @link https://developer.wordpress.org/themes/functionality/sidebars/#registering-a-sidebar
@@ -412 +412 @@
 
 /**
- * Add a pingback url auto-discovery header for singularly identifiable articles.
+ * Adds a pingback url auto-discovery header for singularly identifiable articles.
  */
 function twentyseventeen_pingback_header() {
@@ -422 +422 @@
 
 /**
- * Display custom color CSS.
+ * Displays custom color CSS.
  */
 function twentyseventeen_colors_css_wrap() {
@@ -552 +552 @@
 
 /**
- * Add custom image sizes attribute to enhance responsive image functionality
+ * Adds custom image sizes attribute to enhance responsive image functionality
  * for content images.
  *
@@ -599 +599 @@
 
 /**
- * Add custom image sizes attribute to enhance responsive image functionality
+ * Adds custom image sizes attribute to enhance responsive image functionality
  * for post thumbnails.
  *
@@ -623 +623 @@
 
 /**
- * Use front-page.php when Front page displays is set to a static page.
+ * Uses front-page.php when Front page displays is set to a static page.
  *
  * @since Twenty Seventeen 1.0
@@ -693 +693 @@
 
 /**
- * Show the featured image below the header on single posts and pages, unless the
- * page is the front page.
- *
- * Use the filter `twentyseventeen_should_show_featured_image` in a child theme or
+ * Shows the featured image below the header on single posts and pages, unless
+ * the page is the front page.
+ *
+ * Uses the filter `twentyseventeen_should_show_featured_image` in a child theme or
  * plugin to change when the image is shown. This example prevents the image
  * from showing:
@@ -750 +750 @@
 
 /**
- * Register block patterns and pattern categories.
+ * Registers block patterns and pattern categories.
  *
  * @since Twenty Seventeen 3.8

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

@@ -13 +13 @@
 
 /**
- * Prevent switching to Twenty Seventeen on old versions of WordPress.
+ * Prevents switching to Twenty Seventeen on old versions of WordPress.
  *
  * Switches to the default theme.

trunk/src/wp-content/themes/twentyseventeen/inc/color-patterns.php

@@ -9 +9 @@
 
 /**
- * Generate the CSS for the current custom color scheme.
+ * Generates the CSS for the current custom color scheme.
  */
 function twentyseventeen_custom_colors_css() {

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

@@ -11 +11 @@
 
 /**
- * Set up the WordPress core custom header feature.
+ * Sets up the WordPress core custom header feature.
  *
  * @uses twentyseventeen_header_style()
@@ -119 +119 @@
 
 /**
- * Customize video play/pause button in the custom header.
+ * Customizes video play/pause button in the custom header.
  *
  * @param array $settings Video settings.

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

@@ -9 +9 @@
 
 /**
- * Add postMessage support for site title and description for the Theme Customizer.
+ * Adds postMessage support for site title and description for the Theme Customizer.
  *
  * @param WP_Customize_Manager $wp_customize Theme Customizer object.
@@ -163 +163 @@
 
 /**
- * Sanitize the page layout options.
+ * Sanitizes the page layout options.
  *
  * @param string $input Page layout.
@@ -181 +181 @@
 
 /**
- * Sanitize the colorscheme.
+ * Sanitizes the colorscheme.
  *
  * @param string $input Color scheme.
@@ -196 +196 @@
 
 /**
- * Render the site title for the selective refresh partial.
+ * Renders the site title for the selective refresh partial.
  *
  * @since Twenty Seventeen 1.0
@@ -209 +209 @@
 
 /**
- * Render the site tagline for the selective refresh partial.
+ * Renders the site tagline for the selective refresh partial.
  *
  * @since Twenty Seventeen 1.0
@@ -222 +222 @@
 
 /**
- * Return whether we're previewing the front page and it's a static page.
+ * Returns whether we're previewing the front page and it's a static page.
  *
  * This function is an alias for twentyseventeen_is_frontpage().
@@ -236 +236 @@
 
 /**
- * Return whether we're on a view that supports a one or two column layout.
+ * Returns whether we're on a view that supports a one or two column layout.
  */
 function twentyseventeen_is_view_with_layout_option() {
@@ -244 +244 @@
 
 /**
- * Bind JS handlers to instantly live-preview changes.
+ * Binds JS handlers to instantly live-preview changes.
  */
 function twentyseventeen_customize_preview_js() {
@@ -252 +252 @@
 
 /**
- * Load dynamic logic for the customizer controls area.
+ * Loads dynamic logic for the customizer controls area.
  */
 function twentyseventeen_panels_js() {

trunk/src/wp-content/themes/twentyseventeen/inc/icon-functions.php

@@ -9 +9 @@
 
 /**
- * Add SVG definitions to the footer.
+ * Adds SVG definitions to the footer.
  */
 function twentyseventeen_include_svg_icons() {
@@ -23 +23 @@
 
 /**
- * Return SVG markup.
+ * Returns SVG markup.
  *
  * @param array $args {
@@ -116 +116 @@
 
 /**
- * Display SVG icons in social links menu.
+ * Displays SVG icons in social links menu.
  *
  * @param string   $item_output The menu item's starting HTML output.
@@ -142 +142 @@
 
 /**
- * Add dropdown icon if menu item has children.
+ * Adds dropdown icon if menu item has children.
  *
  * @param string   $title The menu item's title.