HostForge-Systems/wordpress
Template
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

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

Browse Source 
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@60519


git-svn-id: http://core.svn.wordpress.org/trunk@59855 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Sergey Biryukov
2025-07-28 19:18:28 +00:00
parent 91f00d1c4e
commit b00421db31
9 changed files with 63 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

30
wp-content/themes/twentyfourteen/functions.php
View File

@@ -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 @@ endif; // 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 @@ add_action( 'widgets_init', '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 @@ if ( ! function_exists( '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 @@ add_action( 'enqueue_block_editor_assets', '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 @@ endif;
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 @@ if ( ! function_exists( '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 @@ require get_template_directory() . '/inc/template-tags.php';
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 @@ if ( ! class_exists( 'Featured_Content' ) && 'plugins.php' !== $GLOBALS['pagenow
}
/**
* 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.

8
wp-content/themes/twentyfourteen/inc/back-compat.php
View File

@@ -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
*/

12
wp-content/themes/twentyfourteen/inc/custom-header.php
View File

@@ -1,6 +1,6 @@
<?php
/**
* Implement Custom Header functionality for Twenty Fourteen
* Implements Custom Header functionality for Twenty Fourteen
*
* @package WordPress
* @subpackage Twenty_Fourteen
@@ -8,7 +8,7 @@
*/
/**
* 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 @@ add_action( 'after_setup_theme', '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 @@ endif; // 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 @@ endif; // 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 @@ endif; // 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()
*

12
wp-content/themes/twentyfourteen/inc/customizer.php
View File

@@ -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
*/

38
wp-content/themes/twentyfourteen/inc/featured-content.php
View File

@@ -28,7 +28,7 @@ class Featured_Content {
public static $max_posts = 15;
/**
* Instantiate.
* Instantiates.
*
* All custom functionality will be hooked into the "init" action.
*
@@ -39,7 +39,7 @@ class Featured_Content {
}
/**
* Conditionally hook into WordPress.
* Conditionally hooks into WordPress.
*
* Theme must declare that they support this module by adding
* add_theme_support( 'featured-content' ); during after_setup_theme.
@@ -89,7 +89,7 @@ class Featured_Content {
}
/**
* 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
* have a chance to alter the value.
@@ -104,7 +104,7 @@ class Featured_Content {
}
/**
* Get featured posts.
* Gets featured posts.
*
* @since Twenty Fourteen 1.0
*
@@ -129,7 +129,7 @@ class Featured_Content {
}
/**
* Get featured post IDs
* Gets featured post IDs.
*
* This function will return the an array containing the
* post IDs of all featured posts.
@@ -179,7 +179,7 @@ class Featured_Content {
}
/**
* 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
*
@@ -190,7 +190,7 @@ class Featured_Content {
}
/**
* Delete featured content IDs transient.
* Deletes featured content IDs transient.
*
* Hooks in the "save_post" action.
*
@@ -203,9 +203,9 @@ class Featured_Content {
}
/**
* Exclude featured posts from the home page blog query.
* Excludes featured posts from the home page blog query.
*
* Filter the home page posts, and remove any featured post ID's from it.
* 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.
*
@@ -245,7 +245,7 @@ class Featured_Content {
}
/**
* 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,
* too. While it may not be obvious by looking at the function alone,
@@ -272,7 +272,7 @@ class Featured_Content {
}
/**
* 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.
*
@@ -318,7 +318,7 @@ class Featured_Content {
}
/**
* 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.
*
* Hooks into the "get_the_terms" filter.
@@ -360,7 +360,7 @@ class Featured_Content {
}
/**
* Register custom setting on the Settings -> Reading screen.
* Registers custom setting on the Settings -> Reading screen.
*
* @since Twenty Fourteen 1.0
*/
@@ -369,7 +369,7 @@ class Featured_Content {
}
/**
* Add settings to the Customizer.
* Adds settings to the Customizer.
*
* @since Twenty Fourteen 1.0
*
@@ -430,7 +430,7 @@ class Featured_Content {
}
/**
* Enqueue the tag suggestion script.
* Enqueues the tag suggestion script.
*
* @since Twenty Fourteen 1.0
*/
@@ -439,9 +439,9 @@ class Featured_Content {
}
/**
* Get featured content settings.
* Gets featured content settings.
*
* Get all settings recognized by this module. This function
* 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
* at all times.
@@ -475,9 +475,9 @@ class Featured_Content {
}
/**
* Validate featured content settings.
* Validates featured content settings.
*
* Make sure that all user supplied content is in an expected
* 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().
*

14
wp-content/themes/twentyfourteen/inc/template-tags.php
View File

@@ -9,7 +9,7 @@
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
*
@@ -74,7 +74,7 @@ endif;
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
*/
@@ -112,7 +112,7 @@ endif;
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
*/
@@ -134,7 +134,7 @@ if ( ! function_exists( 'twentyfourteen_posted_on' ) ) :
endif;
/**
* Find out if blog has more than one category.
* Finds out if blog has more than one category.
*
* @since Twenty Fourteen 1.0
*
@@ -166,7 +166,7 @@ function twentyfourteen_categorized_blog() {
}
/**
* Flush out the transients used in twentyfourteen_categorized_blog.
* Flushes out the transients used in twentyfourteen_categorized_blog.
*
* @since Twenty Fourteen 1.0
*/
@@ -179,7 +179,7 @@ add_action( 'save_post', 'twentyfourteen_category_transient_flusher' );
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
* views, or a div element when on single views.
@@ -246,7 +246,7 @@ endif;
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.
*

8
wp-content/themes/twentyfourteen/inc/widgets.php
View File

@@ -45,7 +45,7 @@ class Twenty_Fourteen_Ephemera_Widget extends WP_Widget {
}
/**
* Enqueue scripts.
* Enqueues scripts.
*
* @since Twenty Fourteen 1.7
*/
@@ -62,7 +62,7 @@ class Twenty_Fourteen_Ephemera_Widget extends WP_Widget {
}
/**
* Output the HTML for this widget.
* Outputs the HTML for this widget.
*
* @since Twenty Fourteen 1.0
*
@@ -256,7 +256,7 @@ class Twenty_Fourteen_Ephemera_Widget extends WP_Widget {
}
/**
* 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.
*
@@ -280,7 +280,7 @@ class Twenty_Fourteen_Ephemera_Widget extends WP_Widget {
}
/**
* 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
*

2
wp-content/themes/twentyfourteen/js/functions.js
View File

@@ -95,7 +95,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.

2
wp-includes/version.php
View File

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