Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-06-23 13:24:57 +02:00
Code Issues Projects Releases Wiki Activity

Docs: Use third-person singular verbs in various function descriptions, as per docblocks standards.

Browse Source 
Props laurentmagnin, pouicpouic, jbcouton, audrasjb.
See #57840.

Built from https://develop.svn.wordpress.org/trunk@55681


git-svn-id: http://core.svn.wordpress.org/trunk@55193 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
audrasjb 2023-04-24 16:37:22 +00:00
parent 3d744b601c
commit b556c3aa25
4 changed files with 20 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
wp-admin/includes/class-wp-privacy-policy-content.php
View File

@ -20,7 +20,7 @@ final class WP_Privacy_Policy_Content {
private function __construct() {} private function __construct() {}
/** /**
* Add content to the postbox shown when editing the privacy policy. * Adds content to the postbox shown when editing the privacy policy.
* *
* Plugins and themes should suggest text for inclusion in the site's privacy policy. * Plugins and themes should suggest text for inclusion in the site's privacy policy.
* The suggested text should contain information about any functionality that affects user privacy, * The suggested text should contain information about any functionality that affects user privacy,
@ -49,7 +49,7 @@ final class WP_Privacy_Policy_Content {
} }
/** /**
* Quick check if any privacy info has changed. * Performs a quick check to determine whether any privacy info has changed.
* *
* @since 4.9.6 * @since 4.9.6
*/ */
@ -123,7 +123,7 @@ final class WP_Privacy_Policy_Content {
} }
/** /**
* Output a warning when some privacy info has changed. * Outputs a warning when some privacy info has changed.
* *
* @since 4.9.6 * @since 4.9.6
* *
@ -154,7 +154,7 @@ final class WP_Privacy_Policy_Content {
} }
/** /**
* Update the cached policy info when the policy page is updated. * Updates the cached policy info when the policy page is updated.
* *
* @since 4.9.6 * @since 4.9.6
* @access private * @access private
@ -203,7 +203,7 @@ final class WP_Privacy_Policy_Content {
} }
/** /**
* Check for updated, added or removed privacy policy information from plugins. * Checks for updated, added or removed privacy policy information from plugins.
* *
* Caches the current info in post_meta of the policy page. * Caches the current info in post_meta of the policy page.
* *
@ -301,7 +301,7 @@ final class WP_Privacy_Policy_Content {
} }
/** /**
* Add a notice with a link to the guide when editing the privacy policy page. * Adds a notice with a link to the guide when editing the privacy policy page.
* *
* @since 4.9.6 * @since 4.9.6
* @since 5.0.0 The `$post` parameter was made optional. * @since 5.0.0 The `$post` parameter was made optional.
@ -372,7 +372,7 @@ final class WP_Privacy_Policy_Content {
} }
/** /**
* Output the privacy policy guide together with content from the theme and plugins. * Outputs the privacy policy guide together with content from the theme and plugins.
* *
* @since 4.9.6 * @since 4.9.6
*/ */
@ -441,7 +441,7 @@ final class WP_Privacy_Policy_Content {
} }
/** /**
* Return the default suggested privacy policy content. * Returns the default suggested privacy policy content.
* *
* @since 4.9.6 * @since 4.9.6
* @since 5.0.0 Added the `$blocks` parameter. * @since 5.0.0 Added the `$blocks` parameter.
@ -690,7 +690,7 @@ final class WP_Privacy_Policy_Content {
} }
/** /**
* Add the suggested privacy policy text to the policy postbox. * Adds the suggested privacy policy text to the policy postbox.
* *
* @since 4.9.6 * @since 4.9.6
*/ */

12
wp-includes/class-wp-comment.php
View File

@ -219,7 +219,7 @@ final class WP_Comment {
} }
/** /**
* Convert object to array. * Converts object to array.
* *
* @since 4.4.0 * @since 4.4.0
* *
@ -230,7 +230,7 @@ final class WP_Comment {
} }
/** /**
* Get the children of a comment. * Gets the children of a comment.
* *
* @since 4.4.0 * @since 4.4.0
* *
@ -302,7 +302,7 @@ final class WP_Comment {
} }
/** /**
* Add a child to the comment. * Adds a child to the comment.
* *
* Used by `WP_Comment_Query` when bulk-filling descendants. * Used by `WP_Comment_Query` when bulk-filling descendants.
* *
@ -315,7 +315,7 @@ final class WP_Comment {
} }
/** /**
* Get a child comment by ID. * Gets a child comment by ID.
* *
* @since 4.4.0 * @since 4.4.0
* *
@ -331,7 +331,7 @@ final class WP_Comment {
} }
/** /**
* Set the 'populated_children' flag. * Sets the 'populated_children' flag.
* *
* This flag is important for ensuring that calling `get_children()` on a childless comment will not trigger * This flag is important for ensuring that calling `get_children()` on a childless comment will not trigger
* unneeded database queries. * unneeded database queries.
@ -345,7 +345,7 @@ final class WP_Comment {
} }
/** /**
* Check whether a non-public property is set. * Determines whether a non-public property is set.
* *
* If `$name` matches a post field, the comment post will be loaded and the post's value checked. * If `$name` matches a post field, the comment post will be loaded and the post's value checked.
* *

2
wp-includes/version.php
View File

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

8
wp-includes/widgets/class-wp-widget-text.php
View File

@ -44,7 +44,7 @@ class WP_Widget_Text extends WP_Widget {
} }
/** /**
* Add hooks for enqueueing assets when registering all widget instances of this widget class. * Adds hooks for enqueueing assets when registering all widget instances of this widget class.
* *
* @param int $number Optional. The unique order number of this widget instance * @param int $number Optional. The unique order number of this widget instance
* compared to other instances of the same class. Default -1. * compared to other instances of the same class. Default -1.
@ -340,7 +340,7 @@ class WP_Widget_Text extends WP_Widget {
} }
/** /**
* Inject max-width and remove height for videos too constrained to fit inside sidebars on frontend. * Injects max-width and removes height for videos too constrained to fit inside sidebars on frontend.
* *
* @since 4.9.0 * @since 4.9.0
* *
@ -410,7 +410,7 @@ class WP_Widget_Text extends WP_Widget {
} }
/** /**
* Enqueue preview scripts. * Enqueues preview scripts.
* *
* These scripts normally are enqueued just-in-time when a playlist shortcode is used. * These scripts normally are enqueued just-in-time when a playlist shortcode is used.
* However, in the customizer, a playlist shortcode may be used in a text widget and * However, in the customizer, a playlist shortcode may be used in a text widget and
@ -510,7 +510,7 @@ class WP_Widget_Text extends WP_Widget {
} }
/** /**
* Render form template scripts. * Renders form template scripts.
* *
* @since 4.8.0 * @since 4.8.0
* @since 4.9.0 The method is now static. * @since 4.9.0 The method is now static.