Upstream
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

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

Props costdev, audrasjb.
See #57840.



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


git-svn-id: http://core.svn.wordpress.org/trunk@55423 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
audrasjb 2023-06-14 06:34:27 +00:00
parent 68f97dcb83
commit 5be9311067
23 changed files with 92 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
wp-admin/includes/class-core-upgrader.php
View File

@ -21,7 +21,7 @@
class Core_Upgrader extends WP_Upgrader {
/**
* Initialize the upgrade strings.
* Initializes the upgrade strings.
*
* @since 2.8.0
*/
@ -39,7 +39,7 @@ class Core_Upgrader extends WP_Upgrader {
}
/**
* Upgrade WordPress core.
* Upgrades WordPress core.
*
* @since 2.8.0
*
@ -385,7 +385,7 @@ class Core_Upgrader extends WP_Upgrader {
}
/**
* Compare the disk file checksums against the expected checksums.
* Compares the disk file checksums against the expected checksums.
*
* @since 3.7.0
*

2
wp-admin/includes/class-file-upload-upgrader.php
View File

@ -115,7 +115,7 @@ class File_Upload_Upgrader {
}
/**
* Delete the attachment/uploaded file.
* Deletes the attachment/uploaded file.
*
* @since 3.2.2
*

8
wp-admin/includes/class-language-pack-upgrader.php
View File

@ -105,7 +105,7 @@ class Language_Pack_Upgrader extends WP_Upgrader {
}
/**
* Initialize the upgrade strings.
* Initializes the upgrade strings.
*
* @since 3.7.0
*/
@ -123,7 +123,7 @@ class Language_Pack_Upgrader extends WP_Upgrader {
}
/**
* Upgrade a language pack.
* Upgrades a language pack.
*
* @since 3.7.0
*
@ -147,7 +147,7 @@ class Language_Pack_Upgrader extends WP_Upgrader {
}
/**
* Bulk upgrade language packs.
* Upgrades several language packs at once.
*
* @since 3.7.0
*
@ -360,7 +360,7 @@ class Language_Pack_Upgrader extends WP_Upgrader {
}
/**
* Get the name of an item being updated.
* Gets the name of an item being updated.
*
* @since 3.7.0
*

6
wp-admin/includes/class-plugin-installer-skin.php
View File

@ -46,7 +46,7 @@ class Plugin_Installer_Skin extends WP_Upgrader_Skin {
}
/**
* Action to perform before installing a plugin.
* Performs an action before installing a plugin.
*
* @since 2.8.0
*/
@ -81,7 +81,7 @@ class Plugin_Installer_Skin extends WP_Upgrader_Skin {
}
/**
* Action to perform following a plugin install.
* Performs an action following a plugin install.
*
* @since 2.8.0
*/
@ -177,7 +177,7 @@ class Plugin_Installer_Skin extends WP_Upgrader_Skin {
}
/**
* Check if the plugin can be overwritten and output the HTML for overwriting a plugin on upload.
* Checks if the plugin can be overwritten and outputs the HTML for overwriting a plugin on upload.
*
* @since 5.5.0
*

2
wp-admin/includes/class-plugin-upgrader-skin.php
View File

@ -72,7 +72,7 @@ class Plugin_Upgrader_Skin extends WP_Upgrader_Skin {
}
/**
* Action to perform following a single plugin update.
* Performs an action following a single plugin update.
*
* @since 2.8.0
*/

10
wp-admin/includes/class-plugin-upgrader.php
View File

@ -49,7 +49,7 @@ class Plugin_Upgrader extends WP_Upgrader {
public $new_plugin_data = array();
/**
* Initialize the upgrade strings.
* Initializes the upgrade strings.
*
* @since 2.8.0
*/
@ -67,7 +67,7 @@ class Plugin_Upgrader extends WP_Upgrader {
}
/**
* Initialize the installation strings.
* Initializes the installation strings.
*
* @since 2.8.0
*/
@ -173,7 +173,7 @@ class Plugin_Upgrader extends WP_Upgrader {
}
/**
* Upgrade a plugin.
* Upgrades a plugin.
*
* @since 2.8.0
* @since 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
@ -265,7 +265,7 @@ class Plugin_Upgrader extends WP_Upgrader {
}
/**
* Bulk upgrade several plugins at once.
* Upgrades several plugins at once.
*
* @since 2.8.0
* @since 3.7.0 The `$args` parameter was added, making clearing the plugin update cache optional.
@ -479,7 +479,7 @@ class Plugin_Upgrader extends WP_Upgrader {
}
/**
* Retrieve the path to the file that contains the plugin info.
* Retrieves the path to the file that contains the plugin info.
*
* This isn't used internally in the class, but is called by the skins.
*

6
wp-admin/includes/class-theme-installer-skin.php
View File

@ -46,7 +46,7 @@ class Theme_Installer_Skin extends WP_Upgrader_Skin {
}
/**
* Action to perform before installing a theme.
* Performs an action before installing a theme.
*
* @since 2.8.0
*/
@ -81,7 +81,7 @@ class Theme_Installer_Skin extends WP_Upgrader_Skin {
}
/**
* Action to perform following a single theme install.
* Performs an action following a single theme install.
*
* @since 2.8.0
*/
@ -188,7 +188,7 @@ class Theme_Installer_Skin extends WP_Upgrader_Skin {
}
/**
* Check if the theme can be overwritten and output the HTML for overwriting a theme on upload.
* Checks if the theme can be overwritten and outputs the HTML for overwriting a theme on upload.
*
* @since 5.5.0
*

2
wp-admin/includes/class-theme-upgrader-skin.php
View File

@ -51,7 +51,7 @@ class Theme_Upgrader_Skin extends WP_Upgrader_Skin {
}
/**
* Action to perform following a single theme update.
* Performs an action following a single theme update.
*
* @since 2.8.0
*/

18
wp-admin/includes/class-theme-upgrader.php
View File

@ -48,7 +48,7 @@ class Theme_Upgrader extends WP_Upgrader {
public $new_theme_data = array();
/**
* Initialize the upgrade strings.
* Initializes the upgrade strings.
*
* @since 2.8.0
*/
@ -65,7 +65,7 @@ class Theme_Upgrader extends WP_Upgrader {
}
/**
* Initialize the installation strings.
* Initializes the installation strings.
*
* @since 2.8.0
*/
@ -110,7 +110,7 @@ class Theme_Upgrader extends WP_Upgrader {
}
/**
* Check if a child theme is being installed and we need to install its parent.
* Checks if a child theme is being installed and its parent also needs to be installed.
*
* Hooked to the {@see 'upgrader_post_install'} filter by Theme_Upgrader::install().
*
@ -278,7 +278,7 @@ class Theme_Upgrader extends WP_Upgrader {
}
/**
* Upgrade a theme.
* Upgrades a theme.
*
* @since 2.8.0
* @since 3.7.0 The `$args` parameter was added, making clearing the update cache optional.
@ -364,7 +364,7 @@ class Theme_Upgrader extends WP_Upgrader {
}
/**
* Upgrade several themes at once.
* Upgrades several themes at once.
*
* @since 3.0.0
* @since 3.7.0 The `$args` parameter was added, making clearing the update cache optional.
@ -632,7 +632,7 @@ class Theme_Upgrader extends WP_Upgrader {
}
/**
* Turn on maintenance mode before attempting to upgrade the active theme.
* Turns on maintenance mode before attempting to upgrade the active theme.
*
* Hooked to the {@see 'upgrader_pre_install'} filter by Theme_Upgrader::upgrade() and
* Theme_Upgrader::bulk_upgrade().
@ -664,7 +664,7 @@ class Theme_Upgrader extends WP_Upgrader {
}
/**
* Turn off maintenance mode after upgrading the active theme.
* Turns off maintenance mode after upgrading the active theme.
*
* Hooked to the {@see 'upgrader_post_install'} filter by Theme_Upgrader::upgrade()
* and Theme_Upgrader::bulk_upgrade().
@ -702,7 +702,7 @@ class Theme_Upgrader extends WP_Upgrader {
}
/**
* Delete the old theme during an upgrade.
* Deletes the old theme during an upgrade.
*
* Hooked to the {@see 'upgrader_clear_destination'} filter by Theme_Upgrader::upgrade()
* and Theme_Upgrader::bulk_upgrade().
@ -740,7 +740,7 @@ class Theme_Upgrader extends WP_Upgrader {
}
/**
* Get the WP_Theme object for a theme.
* Gets the WP_Theme object for a theme.
*
* @since 2.8.0
* @since 3.0.0 The `$theme` argument was added.

6
wp-admin/includes/class-wp-automatic-updater.php
View File

@ -617,8 +617,8 @@ class WP_Automatic_Updater {
}
/**
* If we tried to perform a core update, check if we should send an email,
* and if we need to avoid processing future updates.
* Checks whether to send an email and avoid processing future updates after
* attempting a core update.
*
* @since 3.7.0
*
@ -967,7 +967,7 @@ class WP_Automatic_Updater {
/**
* If we tried to perform plugin or theme updates, check if we should send an email.
* Checks whether an email should be sent after attempting plugin or theme updates.
*
* @since 5.5.0
*

2
wp-admin/includes/class-wp-links-list-table.php
View File

@ -151,7 +151,7 @@ class WP_Links_List_Table extends WP_List_Table {
}
/**
* Get the name of the default primary column.
* Gets the name of the default primary column.
*
* @since 4.3.0
*

18
wp-admin/includes/class-wp-list-table.php
View File

@ -173,7 +173,7 @@ class WP_List_Table {
}
/**
* Make private properties readable for backward compatibility.
* Makes private properties readable for backward compatibility.
*
* @since 4.0.0
*
@ -187,7 +187,7 @@ class WP_List_Table {
}
/**
* Make private properties settable for backward compatibility.
* Makes private properties settable for backward compatibility.
*
* @since 4.0.0
*
@ -202,7 +202,7 @@ class WP_List_Table {
}
/**
* Make private properties checkable for backward compatibility.
* Makes private properties checkable for backward compatibility.
*
* @since 4.0.0
*
@ -218,7 +218,7 @@ class WP_List_Table {
}
/**
* Make private properties un-settable for backward compatibility.
* Makes private properties un-settable for backward compatibility.
*
* @since 4.0.0
*
@ -231,7 +231,7 @@ class WP_List_Table {
}
/**
* Make private/protected methods readable for backward compatibility.
* Makes private/protected methods readable for backward compatibility.
*
* @since 4.0.0
*
@ -269,7 +269,7 @@ class WP_List_Table {
}
/**
* An internal method that sets all the necessary pagination arguments
* Sets all the necessary pagination arguments.
*
* @since 3.1.0
*
@ -320,7 +320,7 @@ class WP_List_Table {
}
/**
* Whether the table has items to display or not
* Determines whether the table has items to display or not
*
* @since 3.1.0
*
@ -1150,6 +1150,8 @@ class WP_List_Table {
}
/**
* Gets the name of the primary column.
*
* Public wrapper for WP_List_Table::get_default_primary_column_name().
*
* @since 4.4.0
@ -1451,7 +1453,7 @@ class WP_List_Table {
}
/**
* Extra controls to be displayed between bulk actions and pagination.
* Displays extra controls between bulk actions and pagination.
*
* @since 3.1.0
*

2
wp-admin/includes/class-wp-media-list-table.php
View File

@ -263,7 +263,7 @@ class WP_Media_List_Table extends WP_List_Table {
}
/**
* Override parent views so we can use the filter bar display.
* Overrides parent views to use the filter bar display.
*
* @global string $mode List table view mode.
*/

4
wp-admin/includes/class-wp-ms-sites-list-table.php
View File

@ -315,7 +315,7 @@ class WP_MS_Sites_List_Table extends WP_List_Table {
}
/**
* Extra controls to be displayed between bulk actions and pagination.
* Displays extra controls between bulk actions and pagination.
*
* @since 5.3.0
*
@ -621,7 +621,7 @@ class WP_MS_Sites_List_Table extends WP_List_Table {
}
/**
* Maybe output comma-separated site states.
* Determines whether to output comma-separated site states.
*
* @since 5.3.0
*

2
wp-admin/includes/class-wp-plugin-install-list-table.php
View File

@ -30,7 +30,7 @@ class WP_Plugin_Install_List_Table extends WP_List_Table {
}
/**
* Return the list of known plugins.
* Returns the list of known plugins.
*
* Uses the transient data from the updates API to determine the known
* installed plugins.

8
wp-admin/includes/class-wp-posts-list-table.php
View File

@ -226,7 +226,7 @@ class WP_Posts_List_Table extends WP_List_Table {
}
/**
* Determine if the current view is the "All" view.
* Determines if the current view is the "All" view.
*
* @since 4.2.0
*
@ -246,7 +246,7 @@ class WP_Posts_List_Table extends WP_List_Table {
}
/**
* Helper to create links to edit.php with params.
* Creates a link to edit.php with params.
*
* @since 4.4.0
*
@ -917,8 +917,8 @@ class WP_Posts_List_Table extends WP_List_Table {
}
/**
* Given a top level page ID, display the nested hierarchy of sub-pages
* together with paging support
* Displays the nested hierarchy of sub-pages together with paging
* support, based on a top level page ID.
*
* @since 3.1.0 (Standalone function exists since 2.6.0)
* @since 4.2.0 Added the `$to_display` parameter.

4
wp-admin/includes/class-wp-privacy-data-removal-requests-list-table.php
View File

@ -36,7 +36,7 @@ class WP_Privacy_Data_Removal_Requests_List_Table extends WP_Privacy_Requests_Ta
protected $post_type = 'user_request';
/**
* Actions column.
* Outputs the Actions column.
*
* @since 4.9.6
*
@ -108,7 +108,7 @@ class WP_Privacy_Data_Removal_Requests_List_Table extends WP_Privacy_Requests_Ta
}
/**
* Next steps column.
* Outputs the Next steps column.
*
* @since 4.9.6
*

28
wp-admin/includes/class-wp-privacy-requests-table.php
View File

@ -31,7 +31,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
protected $post_type = 'INVALID';
/**
* Get columns to show in the list table.
* Gets columns to show in the list table.
*
* @since 4.9.6
*
@ -49,7 +49,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
}
/**
* Normalize the admin URL to the current page (by request_type).
* Normalizes the admin URL to the current page (by request_type).
*
* @since 5.3.0
*
@ -66,7 +66,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
}
/**
* Get a list of sortable columns.
* Gets a list of sortable columns.
*
* @since 4.9.6
*
@ -87,7 +87,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
}
/**
* Default primary column.
* Returns the default primary column.
*
* @since 4.9.6
*
@ -98,7 +98,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
}
/**
* Count number of requests for each status.
* Counts the number of requests for each status.
*
* @since 4.9.6
*
@ -137,7 +137,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
}
/**
* Get an associative array ( id => link ) with the list of views available on this table.
* Gets an associative array ( id => link ) with the list of views available on this table.
*
* @since 4.9.6
*
@ -200,7 +200,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
}
/**
* Get bulk actions.
* Gets bulk actions.
*
* @since 4.9.6
*
@ -354,7 +354,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
}
/**
* Prepare items to output.
* Prepares items to output.
*
* @since 4.9.6
* @since 5.1.0 Added support for column sorting.
@ -407,7 +407,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
}
/**
* Checkbox column.
* Returns the markup for the Checkbox column.
*
* @since 4.9.6
*
@ -456,7 +456,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
}
/**
* Convert timestamp for display.
* Converts a timestamp for display.
*
* @since 4.9.6
*
@ -479,7 +479,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
}
/**
* Default column handler.
* Handles the default column.
*
* @since 4.9.6
* @since 5.7.0 Added `manage_{$this->screen->id}_custom_column` action.
@ -503,7 +503,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
}
/**
* Created timestamp column. Overridden by children.
* Returns the markup for the Created timestamp column. Overridden by children.
*
* @since 5.7.0
*
@ -527,7 +527,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
}
/**
* Next steps column. Overridden by children.
* Returns the markup for the next steps column. Overridden by children.
*
* @since 4.9.6
*
@ -551,7 +551,7 @@ abstract class WP_Privacy_Requests_Table extends WP_List_Table {
}
/**
* Embed scripts used to perform actions. Overridden by children.
* Embeds scripts used to perform actions. Overridden by children.
*
* @since 4.9.6
*/

2
wp-admin/includes/class-wp-theme-install-list-table.php
View File

@ -544,7 +544,7 @@ class WP_Theme_Install_List_Table extends WP_Themes_List_Table {
}
/**
* Check to see if the theme is already installed.
* Checks to see if the theme is already installed.
*
* @since 3.4.0
*

6
wp-admin/includes/class-wp-upgrader-skin.php
View File

@ -211,21 +211,21 @@ class WP_Upgrader_Skin {
}
/**
* Action to perform before an update.
* Performs an action before an update.
*
* @since 2.8.0
*/
public function before() {}
/**
* Action to perform following an update.
* Performs and action following an update.
*
* @since 2.8.0
*/
public function after() {}
/**
* Output JavaScript that calls function to decrement the update counts.
* Outputs JavaScript that calls function to decrement the update counts.
*
* @since 3.9.0
*

16
wp-admin/includes/class-wp-upgrader.php
View File

@ -149,7 +149,7 @@ class WP_Upgrader {
}
/**
* Initialize the upgrader.
* Initializes the upgrader.
*
* This will set the relationship between the skin being used and this upgrader,
* and also add the generic strings to `WP_Upgrader::$strings`.
@ -180,7 +180,7 @@ class WP_Upgrader {
}
/**
* Add the generic strings to WP_Upgrader::$strings.
* Adds the generic strings to WP_Upgrader::$strings.
*
* @since 2.8.0
*/
@ -217,7 +217,7 @@ class WP_Upgrader {
}
/**
* Connect to the filesystem.
* Connects to the filesystem.
*
* @since 2.8.0
*
@ -289,7 +289,7 @@ class WP_Upgrader {
}
/**
* Download a package.
* Downloads a package.
*
* @since 2.8.0
* @since 5.2.0 Added the `$check_signatures` parameter.
@ -339,7 +339,7 @@ class WP_Upgrader {
}
/**
* Unpack a compressed package file.
* Unpacks a compressed package file.
*
* @since 2.8.0
*
@ -397,7 +397,7 @@ class WP_Upgrader {
}
/**
* Flatten the results of WP_Filesystem_Base::dirlist() for iterating over.
* Flattens the results of WP_Filesystem_Base::dirlist() for iterating over.
*
* @since 4.9.0
* @access protected
@ -712,7 +712,7 @@ class WP_Upgrader {
}
/**
* Run an upgrade/installation.
* Runs an upgrade/installation.
*
* Attempts to download the package (if it is not a local file), unpack it, and
* install it in the destination folder.
@ -960,7 +960,7 @@ class WP_Upgrader {
}
/**
* Toggle maintenance mode for the site.
* Toggles maintenance mode for the site.
*
* Creates/deletes the maintenance file to enable/disable maintenance mode.
*

22
wp-admin/includes/class-wp-users-list-table.php
View File

@ -58,7 +58,7 @@ class WP_Users_List_Table extends WP_List_Table {
}
/**
* Check the current user's permissions.
* Checks the current user's permissions.
*
* @since 3.1.0
*
@ -73,7 +73,7 @@ class WP_Users_List_Table extends WP_List_Table {
}
/**
* Prepare the users list for display.
* Prepares the users list for display.
*
* @since 3.1.0
*
@ -150,7 +150,7 @@ class WP_Users_List_Table extends WP_List_Table {
}
/**
* Output 'no users' message.
* Outputs 'no users' message.
*
* @since 3.1.0
*/
@ -159,7 +159,7 @@ class WP_Users_List_Table extends WP_List_Table {
}
/**
* Return an associative array listing all the views that can be used
* Returns an associative array listing all the views that can be used
* with this table.
*
* Provides a list of roles and user count for that role for easy
@ -262,7 +262,7 @@ class WP_Users_List_Table extends WP_List_Table {
}
/**
* Retrieve an associative array of bulk actions available on this table.
* Retrieves an associative array of bulk actions available on this table.
*
* @since 3.1.0
*
@ -290,7 +290,7 @@ class WP_Users_List_Table extends WP_List_Table {
}
/**
* Output the controls to allow user roles to be changed in bulk.
* Outputs the controls to allow user roles to be changed in bulk.
*
* @since 3.1.0
*
@ -343,7 +343,7 @@ class WP_Users_List_Table extends WP_List_Table {
}
/**
* Capture the bulk action required, and return it.
* Captures the bulk action required, and return it.
*
* Overridden from the base class implementation to capture
* the role change drop-down.
@ -361,7 +361,7 @@ class WP_Users_List_Table extends WP_List_Table {
}
/**
* Get a list of columns for the list table.
* Gets a list of columns for the list table.
*
* @since 3.1.0
*
@ -385,7 +385,7 @@ class WP_Users_List_Table extends WP_List_Table {
}
/**
* Get a list of sortable columns for the list table.
* Gets a list of sortable columns for the list table.
*
* @since 3.1.0
*
@ -401,7 +401,7 @@ class WP_Users_List_Table extends WP_List_Table {
}
/**
* Generate the list table rows.
* Generates the list table rows.
*
* @since 3.1.0
*/
@ -417,7 +417,7 @@ class WP_Users_List_Table extends WP_List_Table {
}
/**
* Generate HTML for a single row on the users.php admin panel.
* Generates HTML for a single row on the users.php admin panel.
*
* @since 3.1.0
* @since 4.2.0 The `$style` parameter was deprecated.

2
wp-includes/version.php
View File

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