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. 

Follow-up to [55911].

Props costdev, audrasjb.
See #57840.



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


git-svn-id: http://core.svn.wordpress.org/trunk@55428 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
audrasjb 2023-06-14 12:57:20 +00:00
parent ddc2c454be
commit 3ce7c7e435
6 changed files with 108 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

186
wp-admin/includes/ajax-actions.php
View File

@ -12,7 +12,7 @@
//
/**
* Ajax handler for the Heartbeat API in the no-privilege context.
* Handles the Heartbeat API in the no-privilege context via AJAX .
*
* Runs when the user is not logged in.
*
@ -76,7 +76,7 @@ function wp_ajax_nopriv_heartbeat() {
//
/**
* Ajax handler for fetching a list table.
* Handles fetching a list table via AJAX.
*
* @since 3.1.0
*/
@ -99,7 +99,7 @@ function wp_ajax_fetch_list() {
}
/**
* Ajax handler for tag search.
* Handles tag search via AJAX.
*
* @since 3.1.0
*/
@ -178,7 +178,7 @@ function wp_ajax_ajax_tag_search() {
}
/**
* Ajax handler for compression testing.
* Handles compression testing via AJAX.
*
* @since 3.1.0
*/
@ -248,7 +248,7 @@ function wp_ajax_wp_compression_test() {
}
/**
* Ajax handler for image editor previews.
* Handles image editor previews via AJAX.
*
* @since 3.1.0
*/
@ -270,7 +270,7 @@ function wp_ajax_imgedit_preview() {
}
/**
* Ajax handler for oEmbed caching.
* Handles oEmbed caching via AJAX.
*
* @since 3.1.0
*
@ -282,7 +282,7 @@ function wp_ajax_oembed_cache() {
}
/**
* Ajax handler for user autocomplete.
* Handles user autocomplete via AJAX.
*
* @since 3.4.0
*/
@ -409,7 +409,7 @@ function wp_ajax_get_community_events() {
}
/**
* Ajax handler for dashboard widgets.
* Handles dashboard widgets via AJAX.
*
* @since 3.4.0
*/
@ -430,7 +430,7 @@ function wp_ajax_dashboard_widgets() {
}
/**
* Ajax handler for Customizer preview logged-in status.
* Handles Customizer preview logged-in status via AJAX.
*
* @since 3.4.0
*/
@ -578,7 +578,7 @@ function _wp_ajax_delete_comment_response( $comment_id, $delta = -1 ) {
//
/**
* Ajax handler for adding a hierarchical term.
* Handles adding a hierarchical term via AJAX.
*
* @since 3.1.0
* @access private
@ -708,7 +708,7 @@ function _wp_ajax_add_hierarchical_term() {
}
/**
* Ajax handler for deleting a comment.
* Handles deleting a comment via AJAX.
*
* @since 3.1.0
*/
@ -778,7 +778,7 @@ function wp_ajax_delete_comment() {
}
/**
* Ajax handler for deleting a tag.
* Handles deleting a tag via AJAX.
*
* @since 3.1.0
*/
@ -805,7 +805,7 @@ function wp_ajax_delete_tag() {
}
/**
* Ajax handler for deleting a link.
* Handles deleting a link via AJAX.
*
* @since 3.1.0
*/
@ -831,7 +831,7 @@ function wp_ajax_delete_link() {
}
/**
* Ajax handler for deleting meta.
* Handles deleting meta via AJAX.
*
* @since 3.1.0
*/
@ -857,7 +857,7 @@ function wp_ajax_delete_meta() {
}
/**
* Ajax handler for deleting a post.
* Handles deleting a post via AJAX.
*
* @since 3.1.0
*
@ -887,7 +887,7 @@ function wp_ajax_delete_post( $action ) {
}
/**
* Ajax handler for sending a post to the Trash.
* Handles sending a post to the Trash via AJAX.
*
* @since 3.1.0
*
@ -923,7 +923,7 @@ function wp_ajax_trash_post( $action ) {
}
/**
* Ajax handler to restore a post from the Trash.
* Handles restoring a post from the Trash via AJAX.
*
* @since 3.1.0
*
@ -938,7 +938,7 @@ function wp_ajax_untrash_post( $action ) {
}
/**
* Ajax handler to delete a page.
* Handles deleting a page via AJAX.
*
* @since 3.1.0
*
@ -968,7 +968,7 @@ function wp_ajax_delete_page( $action ) {
}
/**
* Ajax handler to dim a comment.
* Handles dimming a comment via AJAX.
*
* @since 3.1.0
*/
@ -1024,7 +1024,7 @@ function wp_ajax_dim_comment() {
}
/**
* Ajax handler for adding a link category.
* Handles adding a link category via AJAX.
*
* @since 3.1.0
*
@ -1077,7 +1077,7 @@ function wp_ajax_add_link_category( $action ) {
}
/**
* Ajax handler to add a tag.
* Handles adding a tag via AJAX.
*
* @since 3.1.0
*/
@ -1169,7 +1169,7 @@ function wp_ajax_add_tag() {
}
/**
* Ajax handler for getting a tagcloud.
* Handles getting a tagcloud via AJAX.
*
* @since 3.1.0
*/
@ -1229,7 +1229,7 @@ function wp_ajax_get_tagcloud() {
}
/**
* Ajax handler for getting comments.
* Handles getting comments via AJAX.
*
* @since 3.1.0
*
@ -1292,7 +1292,7 @@ function wp_ajax_get_comments( $action ) {
}
/**
* Ajax handler for replying to a comment.
* Handles replying to a comment via AJAX.
*
* @since 3.1.0
*
@ -1452,7 +1452,7 @@ function wp_ajax_replyto_comment( $action ) {
}
/**
* Ajax handler for editing a comment.
* Handles editing a comment via AJAX.
*
* @since 3.1.0
*/
@ -1507,7 +1507,7 @@ function wp_ajax_edit_comment() {
}
/**
* Ajax handler for adding a menu item.
* Handles adding a menu item via AJAX.
*
* @since 3.1.0
*/
@ -1595,7 +1595,7 @@ function wp_ajax_add_menu_item() {
}
/**
* Ajax handler for adding meta.
* Handles adding meta via AJAX.
*
* @since 3.1.0
*/
@ -1717,7 +1717,7 @@ function wp_ajax_add_meta() {
}
/**
* Ajax handler for adding a user.
* Handles adding a user via AJAX.
*
* @since 3.1.0
*
@ -1772,7 +1772,7 @@ function wp_ajax_add_user( $action ) {
}
/**
* Ajax handler for closed post boxes.
* Handles closed post boxes via AJAX.
*
* @since 3.1.0
*/
@ -1809,7 +1809,7 @@ function wp_ajax_closed_postboxes() {
}
/**
* Ajax handler for hidden columns.
* Handles hidden columns via AJAX.
*
* @since 3.1.0
*/
@ -1833,7 +1833,7 @@ function wp_ajax_hidden_columns() {
}
/**
* Ajax handler for updating whether to display the welcome panel.
* Handles updating whether to display the welcome panel via AJAX.
*
* @since 3.1.0
*/
@ -1850,7 +1850,7 @@ function wp_ajax_update_welcome_panel() {
}
/**
* Ajax handler for retrieving menu meta boxes.
* Handles for retrieving menu meta boxes via AJAX.
*
* @since 3.1.0
*/
@ -1901,7 +1901,7 @@ function wp_ajax_menu_get_metabox() {
}
/**
* Ajax handler for internal linking.
* Handles internal linking via AJAX.
*
* @since 3.1.0
*/
@ -1937,7 +1937,7 @@ function wp_ajax_wp_link_ajax() {
}
/**
* Ajax handler for menu locations save.
* Handles saving menu locations via AJAX.
*
* @since 3.1.0
*/
@ -1957,7 +1957,7 @@ function wp_ajax_menu_locations_save() {
}
/**
* Ajax handler for saving the meta box order.
* Handles saving the meta box order via AJAX.
*
* @since 3.1.0
*/
@ -1993,7 +1993,7 @@ function wp_ajax_meta_box_order() {
}
/**
* Ajax handler for menu quick searching.
* Handles menu quick searching via AJAX.
*
* @since 3.1.0
*/
@ -2010,7 +2010,7 @@ function wp_ajax_menu_quick_search() {
}
/**
* Ajax handler to retrieve a permalink.
* Handles retrieving a permalink via AJAX.
*
* @since 3.1.0
*/
@ -2021,7 +2021,7 @@ function wp_ajax_get_permalink() {
}
/**
* Ajax handler to retrieve a sample permalink.
* Handles retrieving a sample permalink via AJAX.
*
* @since 3.1.0
*/
@ -2034,7 +2034,7 @@ function wp_ajax_sample_permalink() {
}
/**
* Ajax handler for Quick Edit saving a post from a list table.
* Handles Quick Edit saving a post from a list table via AJAX.
*
* @since 3.1.0
*
@ -2153,7 +2153,7 @@ function wp_ajax_inline_save() {
}
/**
* Ajax handler for quick edit saving for a term.
* Handles Quick Edit saving for a term via AJAX.
*
* @since 3.1.0
*/
@ -2213,7 +2213,7 @@ function wp_ajax_inline_save_tax() {
}
/**
* Ajax handler for querying posts for the Find Posts modal.
* Handles querying posts for the Find Posts modal via AJAX.
*
* @see window.findPosts
*
@ -2282,7 +2282,7 @@ function wp_ajax_find_posts() {
}
/**
* Ajax handler for saving the widgets order.
* Handles saving the widgets order via AJAX.
*
* @since 3.1.0
*/
@ -2324,7 +2324,7 @@ function wp_ajax_widgets_order() {
}
/**
* Ajax handler for saving a widget.
* Handles saving a widget via AJAX.
*
* @since 3.1.0
*
@ -2433,7 +2433,7 @@ function wp_ajax_save_widget() {
}
/**
* Ajax handler for updating a widget.
* Handles updating a widget via AJAX.
*
* @since 3.9.0
*
@ -2445,7 +2445,7 @@ function wp_ajax_update_widget() {
}
/**
* Ajax handler for removing inactive widgets.
* Handles removing inactive widgets via AJAX.
*
* @since 4.4.0
*/
@ -2482,7 +2482,7 @@ function wp_ajax_delete_inactive_widgets() {
}
/**
* Ajax handler for creating missing image sub-sizes for just uploaded images.
* Handles creating missing image sub-sizes for just uploaded images via AJAX.
*
* @since 5.3.0
*/
@ -2539,7 +2539,7 @@ function wp_ajax_media_create_image_subsizes() {
}
/**
* Ajax handler for uploading attachments
* Handles uploading attachments via AJAX.
*
* @since 3.3.0
*/
@ -2652,7 +2652,7 @@ function wp_ajax_upload_attachment() {
}
/**
* Ajax handler for image editing.
* Handles image editing via AJAX.
*
* @since 3.1.0
*/
@ -2707,7 +2707,7 @@ function wp_ajax_image_editor() {
}
/**
* Ajax handler for setting the featured image.
* Handles setting the featured image via AJAX.
*
* @since 3.1.0
*/
@ -2745,7 +2745,7 @@ function wp_ajax_set_post_thumbnail() {
}
/**
* Ajax handler for retrieving HTML for the featured image.
* Handles retrieving HTML for the featured image via AJAX.
*
* @since 4.6.0
*/
@ -2770,7 +2770,7 @@ function wp_ajax_get_post_thumbnail_html() {
}
/**
* Ajax handler for setting the featured image for an attachment.
* Handles setting the featured image for an attachment via AJAX.
*
* @since 4.0.0
*
@ -2825,7 +2825,7 @@ function wp_ajax_set_attachment_thumbnail() {
}
/**
* Ajax handler for date formatting.
* Handles formatting a date via AJAX.
*
* @since 3.1.0
*/
@ -2834,7 +2834,7 @@ function wp_ajax_date_format() {
}
/**
* Ajax handler for time formatting.
* Handles formatting a time via AJAX.
*
* @since 3.1.0
*/
@ -2843,7 +2843,7 @@ function wp_ajax_time_format() {
}
/**
* Ajax handler for saving posts from the fullscreen editor.
* Handles saving posts from the fullscreen editor via AJAX.
*
* @since 3.1.0
* @deprecated 4.3.0
@ -2887,7 +2887,7 @@ function wp_ajax_wp_fullscreen_save_post() {
}
/**
* Ajax handler for removing a post lock.
* Handles removing a post lock via AJAX.
*
* @since 3.1.0
*/
@ -2929,7 +2929,7 @@ function wp_ajax_wp_remove_post_lock() {
}
/**
* Ajax handler for dismissing a WordPress pointer.
* Handles dismissing a WordPress pointer via AJAX.
*
* @since 3.1.0
*/
@ -2956,7 +2956,7 @@ function wp_ajax_dismiss_wp_pointer() {
}
/**
* Ajax handler for getting an attachment.
* Handles getting an attachment via AJAX.
*
* @since 3.5.0
*/
@ -2992,7 +2992,7 @@ function wp_ajax_get_attachment() {
}
/**
* Ajax handler for querying attachments.
* Handles querying attachments via AJAX.
*
* @since 3.5.0
*/
@ -3083,7 +3083,7 @@ function wp_ajax_query_attachments() {
}
/**
* Ajax handler for updating attachment attributes.
* Handles updating attachment attributes via AJAX.
*
* @since 3.5.0
*/
@ -3169,7 +3169,7 @@ function wp_ajax_save_attachment() {
}
/**
* Ajax handler for saving backward compatible attachment attributes.
* Handles saving backward compatible attachment attributes via AJAX.
*
* @since 3.5.0
*/
@ -3227,7 +3227,7 @@ function wp_ajax_save_attachment_compat() {
}
/**
* Ajax handler for saving the attachment order.
* Handles saving the attachment order via AJAX.
*
* @since 3.5.0
*/
@ -3280,7 +3280,7 @@ function wp_ajax_save_attachment_order() {
}
/**
* Ajax handler for sending an attachment to the editor.
* Handles sending an attachment to the editor via AJAX.
*
* Generates the HTML to send an attachment to the editor.
* Backward compatible with the {@see 'media_send_to_editor'} filter
@ -3354,7 +3354,7 @@ function wp_ajax_send_attachment_to_editor() {
}
/**
* Ajax handler for sending a link to the editor.
* Handles sending a link to the editor via AJAX.
*
* Generates the HTML to send a non-image embed link to the editor.
*
@ -3426,7 +3426,7 @@ function wp_ajax_send_link_to_editor() {
}
/**
* Ajax handler for the Heartbeat API.
* Handles the Heartbeat API via AJAX.
*
* Runs when the user is logged in.
*
@ -3513,7 +3513,7 @@ function wp_ajax_heartbeat() {
}
/**
* Ajax handler for getting revision diffs.
* Handles getting revision diffs via AJAX.
*
* @since 3.6.0
*/
@ -3553,8 +3553,8 @@ function wp_ajax_get_revision_diffs() {
}
/**
* Ajax handler for auto-saving the selected color scheme for
* a user's own profile.
* Handles auto-saving the selected color scheme for
* a user's own profile via AJAX.
*
* @since 3.8.0
*
@ -3583,7 +3583,7 @@ function wp_ajax_save_user_color_scheme() {
}
/**
* Ajax handler for getting themes from themes_api().
* Handles getting themes from themes_api() via AJAX.
*
* @since 3.9.0
*
@ -3714,7 +3714,7 @@ function wp_ajax_query_themes() {
}
/**
* Apply [embed] Ajax handlers to a string.
* Applies [embed] Ajax handlers to a string.
*
* @since 4.0.0
*
@ -3926,7 +3926,7 @@ function wp_ajax_parse_media_shortcode() {
}
/**
* Ajax handler for destroying multiple open sessions for a user.
* Handles destroying multiple open sessions for a user via AJAX.
*
* @since 4.1.0
*/
@ -3964,7 +3964,7 @@ function wp_ajax_destroy_sessions() {
}
/**
* Ajax handler for cropping an image.
* Handles cropping an image via AJAX.
*
* @since 4.3.0
*/
@ -4103,7 +4103,7 @@ function wp_ajax_crop_image() {
}
/**
* Ajax handler for generating a password.
* Handles generating a password via AJAX.
*
* @since 4.4.0
*/
@ -4112,7 +4112,7 @@ function wp_ajax_generate_password() {
}
/**
* Ajax handler for generating a password in the no-privilege context.
* Handles generating a password in the no-privilege context via AJAX.
*
* @since 5.7.0
*/
@ -4121,7 +4121,7 @@ function wp_ajax_nopriv_generate_password() {
}
/**
* Ajax handler for saving the user's WordPress.org username.
* Handles saving the user's WordPress.org username via AJAX.
*
* @since 4.4.0
*/
@ -4142,7 +4142,7 @@ function wp_ajax_save_wporg_username() {
}
/**
* Ajax handler for installing a theme.
* Handles installing a theme via AJAX.
*
* @since 4.6.0
*
@ -4268,7 +4268,7 @@ function wp_ajax_install_theme() {
}
/**
* Ajax handler for updating a theme.
* Handles updating a theme via AJAX.
*
* @since 4.6.0
*
@ -4363,7 +4363,7 @@ function wp_ajax_update_theme() {
}
/**
* Ajax handler for deleting a theme.
* Handles deleting a theme via AJAX.
*
* @since 4.6.0
*
@ -4437,7 +4437,7 @@ function wp_ajax_delete_theme() {
}
/**
* Ajax handler for installing a plugin.
* Handles installing a plugin via AJAX.
*
* @since 4.6.0
*
@ -4546,7 +4546,7 @@ function wp_ajax_install_plugin() {
}
/**
* Ajax handler for updating a plugin.
* Handles updating a plugin via AJAX.
*
* @since 4.2.0
*
@ -4654,7 +4654,7 @@ function wp_ajax_update_plugin() {
}
/**
* Ajax handler for deleting a plugin.
* Handles deleting a plugin via AJAX.
*
* @since 4.6.0
*
@ -4731,7 +4731,7 @@ function wp_ajax_delete_plugin() {
}
/**
* Ajax handler for searching plugins.
* Handles searching plugins via AJAX.
*
* @since 4.6.0
*
@ -4788,7 +4788,7 @@ function wp_ajax_search_plugins() {
}
/**
* Ajax handler for searching plugins to install.
* Handles searching plugins to install via AJAX.
*
* @since 4.6.0
*/
@ -4838,7 +4838,7 @@ function wp_ajax_search_install_plugins() {
}
/**
* Ajax handler for editing a theme or plugin file.
* Handles editing a theme or plugin file via AJAX.
*
* @since 4.9.0
*
@ -4867,7 +4867,7 @@ function wp_ajax_edit_theme_plugin_file() {
}
/**
* Ajax handler for exporting a user's personal data.
* Handles exporting a user's personal data via AJAX.
*
* @since 4.9.6
*/
@ -5057,7 +5057,7 @@ function wp_ajax_wp_privacy_export_personal_data() {
}
/**
* Ajax handler for erasing personal data.
* Handles erasing personal data via AJAX.
*
* @since 4.9.6
*/
@ -5286,7 +5286,7 @@ function wp_ajax_wp_privacy_erase_personal_data() {
}
/**
* Ajax handler for site health checks on server communication.
* Handles site health checks on server communication via AJAX.
*
* @since 5.2.0
* @deprecated 5.6.0 Use WP_REST_Site_Health_Controller::test_dotorg_communication()
@ -5319,7 +5319,7 @@ function wp_ajax_health_check_dotorg_communication() {
}
/**
* Ajax handler for site health checks on background updates.
* Handles site health checks on background updates via AJAX.
*
* @since 5.2.0
* @deprecated 5.6.0 Use WP_REST_Site_Health_Controller::test_background_updates()
@ -5352,7 +5352,7 @@ function wp_ajax_health_check_background_updates() {
}
/**
* Ajax handler for site health checks on loopback requests.
* Handles site health checks on loopback requests via AJAX.
*
* @since 5.2.0
* @deprecated 5.6.0 Use WP_REST_Site_Health_Controller::test_loopback_requests()
@ -5385,7 +5385,7 @@ function wp_ajax_health_check_loopback_requests() {
}
/**
* Ajax handler for site health check to update the result status.
* Handles site health check to update the result status via AJAX.
*
* @since 5.2.0
*/
@ -5402,7 +5402,7 @@ function wp_ajax_health_check_site_status_result() {
}
/**
* Ajax handler for site health check to get directories and database sizes.
* Handles site health check to get directories and database sizes via AJAX.
*
* @since 5.2.0
* @deprecated 5.6.0 Use WP_REST_Site_Health_Controller::get_directory_sizes()
@ -5468,7 +5468,7 @@ function wp_ajax_health_check_get_sizes() {
}
/**
* Ajax handler to renew the REST API nonce.
* Handles renewing the REST API nonce via AJAX.
*
* @since 5.3.0
*/
@ -5477,7 +5477,7 @@ function wp_ajax_rest_nonce() {
}
/**
* Ajax handler to enable or disable plugin and theme auto-updates.
* Handles enabling or disable plugin and theme auto-updates via AJAX.
*
* @since 5.5.0
*/
@ -5547,7 +5547,7 @@ function wp_ajax_toggle_auto_updates() {
}
/**
* Ajax handler sends a password reset link.
* Handles sending a password reset link via AJAX.
*
* @since 5.7.0
*/

2
wp-admin/includes/class-wp-importer.php
View File

@ -187,7 +187,7 @@ class WP_Importer {
}
/**
* GET URL
* Gets URL.
*
* @param string $url
* @param string $username

2
wp-admin/includes/class-wp-internal-pointers.php
View File

@ -104,7 +104,7 @@ final class WP_Internal_Pointers {
}
/**
* Print the pointer JavaScript data.
* Prints the pointer JavaScript data.
*
* @since 3.3.0
*

6
wp-admin/includes/credits.php
View File

@ -8,7 +8,7 @@
*/
/**
* Retrieve the contributor credits.
* Retrieves the contributor credits.
*
* @since 3.2.0
* @since 5.6.0 Added the `$version` and `$locale` parameters.
@ -61,7 +61,7 @@ function wp_credits( $version = '', $locale = '' ) {
}
/**
* Retrieve the link to a contributor's WordPress.org profile page.
* Retrieves the link to a contributor's WordPress.org profile page.
*
* @access private
* @since 3.2.0
@ -75,7 +75,7 @@ function _wp_credits_add_profile_link( &$display_name, $username, $profiles ) {
}
/**
* Retrieve the link to an external library used in WordPress.
* Retrieves the link to an external library used in WordPress.
*
* @access private
* @since 3.2.0

15
wp-admin/includes/dashboard.php
View File

@ -532,7 +532,7 @@ function wp_network_dashboard_right_now() {
}
/**
* The Quick Draft widget display and creation of drafts.
* Displays the Quick Draft widget.
*
* @since 3.8.0
*
@ -920,7 +920,9 @@ function _wp_dashboard_recent_comments_row( &$comment, $show_date = true ) {
}
/**
* Callback function for Activity widget.
* Outputs the Activity widget.
*
* Callback function for {@see 'dashboard_activity'}.
*
* @since 3.8.0
*/
@ -1227,10 +1229,9 @@ function wp_dashboard_trigger_widget_control( $widget_control_id = false ) {
}
/**
* The RSS dashboard widget control.
* Sets up the RSS dashboard widget control and $args to be used as input to wp_widget_rss_form().
*
* Sets up $args to be used as input to wp_widget_rss_form(). Handles POST data
* from RSS-type widgets.
* Handles POST data from RSS-type widgets.
*
* @since 2.5.0
*
@ -2023,7 +2024,9 @@ function wp_dashboard_site_health() {
}
/**
* Empty function usable by plugins to output empty dashboard widget (to be populated later by JS).
* Outputs empty dashboard widget to be populated by JS later.
*
* Usable by plugins.
*
* @since 2.5.0
*/

2
wp-includes/version.php
View File

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