Twenty Thirteen: 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.
Built from https://develop.svn.wordpress.org/trunk@60515


git-svn-id: http://core.svn.wordpress.org/trunk@59851 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov
2025-07-27 13:05:28 +00:00
parent a1c733124b
commit 3154f02e61
5 changed files with 33 additions and 36 deletions

View File

@@ -46,7 +46,7 @@ if ( version_compare( $GLOBALS['wp_version'], '3.6-alpha', '<' ) ) {
}
/**
* Register block patterns and pattern categories.
* Registers block patterns and pattern categories.
*
* @since Twenty Thirteen 4.3
*/
@@ -262,7 +262,7 @@ add_action( 'after_setup_theme', 'twentythirteen_setup' );
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
* that use characters not supported by the font, the font can be disabled.
@@ -306,7 +306,7 @@ if ( ! function_exists( 'twentythirteen_fonts_url' ) ) :
endif;
/**
* Enqueue scripts and styles for the front end.
* Enqueues scripts and styles for the front end.
*
* @since Twenty Thirteen 1.0
*/
@@ -356,7 +356,7 @@ function twentythirteen_scripts_styles() {
add_action( 'wp_enqueue_scripts', 'twentythirteen_scripts_styles' );
/**
* Add preconnect for Google Fonts.
* Adds preconnect for Google Fonts.
*
* @since Twenty Thirteen 2.1
* @deprecated Twenty Thirteen 3.8 Disabled filter because, by default, fonts are self-hosted.
@@ -382,7 +382,7 @@ function twentythirteen_resource_hints( $urls, $relation_type ) {
// add_filter( 'wp_resource_hints', 'twentythirteen_resource_hints', 10, 2 );
/**
* Enqueue styles for the block-based editor.
* Enqueues styles for the block-based editor.
*
* @since Twenty Thirteen 2.5
*/
@@ -396,7 +396,7 @@ function twentythirteen_block_editor_styles() {
add_action( 'enqueue_block_editor_assets', 'twentythirteen_block_editor_styles' );
/**
* Filter the page title.
* Filters the page title.
*
* Creates a nicely formatted and more specific title element text for output
* in head of document, based on current view.
@@ -437,7 +437,7 @@ function twentythirteen_wp_title( $title, $sep ) {
add_filter( 'wp_title', 'twentythirteen_wp_title', 10, 2 );
/**
* Register two widget areas.
* Registers two widget areas.
*
* @since Twenty Thirteen 1.0
*/
@@ -484,7 +484,7 @@ endif;
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
*/
@@ -521,7 +521,7 @@ endif;
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
*
@@ -558,7 +558,7 @@ endif;
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.
*
@@ -598,7 +598,7 @@ endif;
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.
*
@@ -634,7 +634,7 @@ endif;
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
*/
@@ -700,7 +700,7 @@ if ( ! function_exists( 'twentythirteen_the_attached_image' ) ) :
endif;
/**
* 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
* the first link found in the post content.
@@ -741,7 +741,7 @@ if ( ! function_exists( 'twentythirteen_excerpt_more' ) && ! is_admin() ) :
endif;
/**
* Extend the default WordPress body classes.
* Extends the default WordPress body classes.
*
* Adds body classes to denote:
* 1. Single or multiple authors.
@@ -771,7 +771,7 @@ function twentythirteen_body_class( $classes ) {
add_filter( 'body_class', 'twentythirteen_body_class' );
/**
* 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
*
@@ -789,7 +789,7 @@ function twentythirteen_content_width() {
add_action( 'template_redirect', 'twentythirteen_content_width' );
/**
* 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
*
@@ -822,7 +822,7 @@ function twentythirteen_customize_register( $wp_customize ) {
add_action( 'customize_register', 'twentythirteen_customize_register' );
/**
* Render the site title for the selective refresh partial.
* Renders the site title for the selective refresh partial.
*
* @since Twenty Thirteen 1.9
*
@@ -835,7 +835,7 @@ function twentythirteen_customize_partial_blogname() {
}
/**
* Render the site tagline for the selective refresh partial.
* Renders the site tagline for the selective refresh partial.
*
* @since Twenty Thirteen 1.9
*
@@ -848,7 +848,7 @@ function twentythirteen_customize_partial_blogdescription() {
}
/**
* Enqueue JavaScript postMessage handlers for the Customizer.
* Enqueues JavaScript postMessage handlers for the Customizer.
*
* Binds JavaScript handlers to make the Customizer preview
* reload changes asynchronously.
@@ -903,7 +903,7 @@ add_filter( 'author_template', 'twentythirteen_author_bio_template' );
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.
*
@@ -920,16 +920,13 @@ if ( ! function_exists( 'wp_body_open' ) ) :
endif;
/**
* Register Custom Block Styles
* Registers Custom Block Styles.
*
* @since Twenty Thirteen 3.4
*/
if ( function_exists( 'register_block_style' ) ) {
function twentythirteen_register_block_styles() {
/**
* Register block style
*/
register_block_style(
'core/button',
array(

View File

@@ -12,7 +12,7 @@
*/
/**
* 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.
*
@@ -26,7 +26,7 @@ function twentythirteen_switch_theme() {
add_action( 'after_switch_theme', 'twentythirteen_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 Thirteen on WordPress versions prior to 3.6.
@@ -45,7 +45,7 @@ function twentythirteen_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 Thirteen 1.0
*/
@@ -65,7 +65,7 @@ function twentythirteen_customize() {
add_action( 'load-customize.php', 'twentythirteen_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 Thirteen 1.0
*/

View File

@@ -1,6 +1,6 @@
<?php
/**
* Implement a custom header for Twenty Thirteen
* Implements a custom header for Twenty Thirteen
*
* @link https://codex.wordpress.org/Custom_Headers
*
@@ -10,7 +10,7 @@
*/
/**
* 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.
* @uses twentythirteen_header_style() to style front end.
@@ -65,7 +65,7 @@ function twentythirteen_custom_header_setup() {
add_action( 'after_setup_theme', 'twentythirteen_custom_header_setup', 11 );
/**
* Load our special font CSS files.
* Loads our special font CSS files.
*
* @since Twenty Thirteen 1.0
*/
@@ -79,7 +79,7 @@ function twentythirteen_custom_header_fonts() {
add_action( 'admin_print_styles-appearance_page_custom-header', 'twentythirteen_custom_header_fonts' );
/**
* 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.
*
@@ -147,7 +147,7 @@ function twentythirteen_header_style() {
}
/**
* 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
*/
@@ -212,7 +212,7 @@ function twentythirteen_admin_header_style() {
}
/**
* 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.
*

View File

@@ -75,7 +75,7 @@
} )();
/**
* Add or remove ARIA attributes.
* Adds or removes ARIA attributes.
*
* Uses jQuery's width() function to determine the size of the window and add
* the default ARIA attributes for the menu toggle if it's visible.

View File

@@ -16,7 +16,7 @@
*
* @global string $wp_version
*/
$wp_version = '6.9-alpha-60514';
$wp_version = '6.9-alpha-60515';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.