Changeset 38369

Timestamp:

08/26/2016 04:48:17 PM (8 years ago)

Author:

johnbillion

Message:

Docs: Correct various documentation around object and stdClass types.

See #37770

Location:

trunk/src

Files:

• wp-admin/includes/user.php (modified) (1 diff)
• wp-includes/class-oembed.php (modified) (1 diff)
• wp-includes/class-wp-site.php (modified) (2 diffs)
• wp-includes/link-template.php (modified) (1 diff)
• wp-includes/nav-menu-template.php (modified) (1 diff)
• wp-includes/nav-menu.php (modified) (1 diff)
• wp-includes/widgets/class-wp-nav-menu-widget.php (modified) (1 diff)

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

@@ -172 +172 @@
      * @param WP_Error &$errors WP_Error object, passed by reference.
      * @param bool     $update  Whether this is a user update.
-     * @param WP_User  &$user   WP_User object, passed by reference.
+     * @param stdClass &$user   User object, passed by reference.
      */
     do_action_ref_array( 'user_profile_update_errors', array( &$errors, $update, &$user ) );

trunk/src/wp-includes/class-oembed.php

@@ -557 +557 @@
      *
      * @param string $response_body
-     * @return object|false
+     * @return stdClass|false
      */
     private function _parse_xml_body( $response_body ) {

trunk/src/wp-includes/class-wp-site.php

@@ -311 +311 @@
      * @see WP_Site::__get()
      *
-     * @return object A raw site object with all details included.
+     * @return stdClass A raw site object with all details included.
      */
     private function get_details() {
@@ -348 +348 @@
          * @since 4.6.0
          *
-         * @param object $details The site details.
+         * @param stdClass $details The site details.
          */
         $details = apply_filters( 'site_details', $details );

trunk/src/wp-includes/link-template.php

@@ -177 +177 @@
                  * @since 3.5.0
                  *
-                 * @param stdClass $cat  The category to use in the permalink.
-                 * @param array    $cats Array of all categories associated with the post.
+                 * @param WP_Term  $cat  The category to use in the permalink.
+                 * @param array    $cats Array of all categories (WP_Term objects) associated with the post.
                  * @param WP_Post  $post The post in question.
                  */

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

@@ -21 +21 @@
  *     Optional. Array of nav menu arguments.
  *
- *     @type string        $menu            Desired menu. Accepts (matching in order) id, slug, name. Default empty.
+ *     @type int|string|WP_Term $menu       Desired menu. Accepts (matching in order) id, slug, name, menu object. Default empty.
  *     @type string        $menu_class      CSS class to use for the ul element which forms the menu. Default 'menu'.
  *     @type string        $menu_id         The ID that is applied to the ul element which forms the menu.

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

@@ -13 +13 @@
  * @since 3.0.0
  *
- * @param string $menu Menu ID, slug, or name - or the menu object.
- * @return object|false False if $menu param isn't supplied or term does not exist, menu object if successful.
+ * @param int|string|WP_Term $menu Menu ID, slug, or name - or the menu object.
+ * @return WP_Term|false False if $menu param isn't supplied or term does not exist, menu object if successful.
  */
 function wp_get_nav_menu_object( $menu ) {

trunk/src/wp-includes/widgets/class-wp-nav-menu-widget.php

@@ -73 +73 @@
          *     @type mixed         $menu        Menu ID, slug, or name.
          * }
-         * @param stdClass $nav_menu      Nav menu object for the current menu.
+         * @param WP_Term  $nav_menu      Nav menu object for the current menu.
          * @param array    $args          Display arguments for the current widget.
          * @param array    $instance      Array of settings for the current widget.