Changeset 46826

Timestamp:

12/07/2019 01:21:07 PM (5 years ago)

Author:

johnbillion

Message:

Docs: Further docblock corrections and improvements.

See #48303

Location:

trunk/src/wp-admin/includes

Files:

• nav-menu.php (modified) (1 diff)
• post.php (modified) (2 diffs)
• screen.php (modified) (3 diffs)
• user.php (modified) (1 diff)

trunk/src/wp-admin/includes/nav-menu.php

@@ -971 +971 @@
  *
  * @param object $object The post type or taxonomy meta-object.
- * @return object The post type of taxonomy object.
+ * @return object The post type or taxonomy object.
  */
 function _wp_nav_menu_meta_box_object( $object = null ) {

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

@@ -16 +16 @@
  * @param bool $update Are we updating a pre-existing post?
  * @param array $post_data Array of post data. Defaults to the contents of $_POST.
- * @return object|bool WP_Error on failure, true on success.
+ * @return array|WP_Error Array of post data on success, WP_Error on failure.
  */
 function _wp_translate_postdata( $update = false, $post_data = null ) {
@@ -202 +202 @@
  *
  * @param array $post_data Array of post data. Defaults to the contents of $_POST.
- * @return object|bool WP_Error on failure, true on success.
+ * @return array|WP_Error Array of post data on success, WP_Error on failure.
  */
 function _wp_get_allowed_postdata( $post_data = null ) {

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

@@ -49 +49 @@
  *
  * @param string|WP_Screen $screen The screen you want the hidden columns for
- * @return array
+ * @return string[] Array of IDs of hidden columns.
  */
 function get_hidden_columns( $screen ) {
@@ -68 +68 @@
          * @since 4.4.0
          *
-         * @param array     $hidden An array of columns hidden by default.
+         * @param string[]  $hidden Array of IDs of columns hidden by default.
          * @param WP_Screen $screen WP_Screen object of the current screen.
          */
@@ -80 +80 @@
      * @since 4.4.1 Added the `use_defaults` parameter.
      *
-     * @param array     $hidden An array of hidden columns.
-     * @param WP_Screen $screen WP_Screen object of the current screen.
+     * @param string[]  $hidden       Array of IDs of hidden columns.
+     * @param WP_Screen $screen       WP_Screen object of the current screen.
      * @param bool      $use_defaults Whether to show the default columns.
      */

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

@@ -552 +552 @@
  * @since 2.7.0
  *
- * @param object $user User data object.
+ * @param WP_User $user User data object.
  */
 function use_ssl_preference( $user ) {