Docs: Miscellaneous docblock corrections and improvements.

See #51800.
Built from https://develop.svn.wordpress.org/trunk@49942


git-svn-id: http://core.svn.wordpress.org/trunk@49641 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
John Blackbourn 2021-01-07 14:17:11 +00:00
parent c38bdce55b
commit f0078d043e
7 changed files with 22 additions and 15 deletions

View File

@ -396,7 +396,7 @@ class WP_List_Table {
* Filters the list of available list table views.
*
* The dynamic portion of the hook name, `$this->screen->id`, refers
* to the ID of the current screen, usually a string.
* to the ID of the current screen.
*
* @since 3.1.0
*

View File

@ -734,7 +734,7 @@ function validate_file_to_edit( $file, $allowed_files = array() ) {
* @see wp_unique_filename().
* @type string[] $upload_error_strings The strings that describe the error indicated in
* `$_FILES[{form field}]['error']`.
* @type bool $test_form Whether to test that the `$_POST['action]` parameter is as expected.
* @type bool $test_form Whether to test that the `$_POST['action']` parameter is as expected.
* @type bool $test_size Whether to test that the file size is greater than zero bytes.
* @type bool $test_type Whether to test that the mime type of the file is as expected.
* @type string[] $mimes Array of allowed mime types keyed by their file extension regex.

View File

@ -2323,9 +2323,9 @@ function register_setting( $option_group, $option_name, $args = array() ) {
* @global array $new_allowed_options
* @global array $wp_registered_settings
*
* @param string $option_group The settings group name used during registration.
* @param string $option_name The name of the option to unregister.
* @param callable $deprecated Deprecated.
* @param string $option_group The settings group name used during registration.
* @param string $option_name The name of the option to unregister.
* @param callable|string $deprecated Deprecated.
*/
function unregister_setting( $option_group, $option_name, $deprecated = '' ) {
global $new_allowed_options, $wp_registered_settings;

View File

@ -1860,10 +1860,16 @@ class WP_REST_Posts_Controller extends WP_REST_Controller {
}
/**
* Filters the post data for a response.
* Filters the post data for a REST API response.
*
* The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
*
* Possible filter names include:
*
* - `rest_prepare_post`
* - `rest_prepare_page`
* - `rest_prepare_attachment`
*
* @since 4.7.0
*
* @param WP_REST_Response $response The response object.

View File

@ -828,10 +828,15 @@ class WP_REST_Terms_Controller extends WP_REST_Controller {
$response->add_links( $this->prepare_links( $item ) );
/**
* Filters a term item returned from the REST API.
* Filters the term data for a REST API response.
*
* The dynamic portion of the hook name, `$this->taxonomy`, refers to the taxonomy slug.
*
* Possible filter names include:
*
* - `rest_prepare_category`
* - `rest_prepare_post_tag`
*
* Allows modification of the term data right before it is returned.
*
* @since 4.7.0

View File

@ -13,7 +13,7 @@
*
* @global string $wp_version
*/
$wp_version = '5.7-alpha-49941';
$wp_version = '5.7-alpha-49942';
/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.

View File

@ -2083,11 +2083,10 @@ class wpdb {
*/
public function log_query( $query, $query_time, $query_callstack, $query_start, $query_data ) {
/**
* Filters the custom query data being logged.
* Filters the custom data to log alongside a query.
*
* Caution should be used when modifying any of this data, it is recommended that any additional
* information you need to store about a query be added as a new associative entry to the fourth
* element $query_data.
* information you need to store about a query be added as a new associative array element.
*
* @since 5.3.0
*
@ -3646,10 +3645,7 @@ class wpdb {
}
/**
* Retrieves the name of the function that called wpdb.
*
* Searches up the list of functions until it reaches the one that would
* most logically had called this method.
* Retrieves a comma-separated list of the names of the functions that called wpdb.
*
* @since 2.5.0
*