Changeset 49942

Timestamp:

01/07/2021 02:15:27 PM (4 years ago)

Author:

johnbillion

Message:

Docs: Miscellaneous docblock corrections and improvements.

See #51800.

Location:

trunk/src

Files:

• wp-admin/includes/class-wp-list-table.php (modified) (1 diff)
• wp-admin/includes/file.php (modified) (1 diff)
• wp-includes/option.php (modified) (1 diff)
• wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php (modified) (1 diff)
• wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php (modified) (1 diff)
• wp-includes/wp-db.php (modified) (2 diffs)

trunk/src/wp-admin/includes/class-wp-list-table.php

@@ -397 +397 @@
          *
          * 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

trunk/src/wp-admin/includes/file.php

@@ -735 +735 @@
  *     @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.

trunk/src/wp-includes/option.php

@@ -2324 +2324 @@
  * @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 = '' ) {

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

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

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

@@ -829 +829 @@
 
         /**
-         * 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.

trunk/src/wp-includes/wp-db.php

@@ -2084 +2084 @@
     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
@@ -3647 +3646 @@
 
     /**
-     * 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