WordPress.org

Make WordPress Core

Changeset 38369


Ignore:
Timestamp:
08/26/2016 04:48:17 PM (4 years ago)
Author:
johnbillion
Message:

Docs: Correct various documentation around object and stdClass types.

See #37770

Location:
trunk/src
Files:
7 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-admin/includes/user.php

    r37537 r38369  
    172172     * @param WP_Error &$errors WP_Error object, passed by reference.
    173173     * @param bool     $update  Whether this is a user update.
    174      * @param WP_User  &$user   WP_User object, passed by reference.
     174     * @param stdClass &$user   User object, passed by reference.
    175175     */
    176176    do_action_ref_array( 'user_profile_update_errors', array( &$errors, $update, &$user ) );
  • trunk/src/wp-includes/class-oembed.php

    r38368 r38369  
    557557     *
    558558     * @param string $response_body
    559      * @return object|false
     559     * @return stdClass|false
    560560     */
    561561    private function _parse_xml_body( $response_body ) {
  • trunk/src/wp-includes/class-wp-site.php

    r38121 r38369  
    311311     * @see WP_Site::__get()
    312312     *
    313      * @return object A raw site object with all details included.
     313     * @return stdClass A raw site object with all details included.
    314314     */
    315315    private function get_details() {
     
    348348         * @since 4.6.0
    349349         *
    350          * @param object $details The site details.
     350         * @param stdClass $details The site details.
    351351         */
    352352        $details = apply_filters( 'site_details', $details );
  • trunk/src/wp-includes/link-template.php

    r38125 r38369  
    177177                 * @since 3.5.0
    178178                 *
    179                  * @param stdClass $cat  The category to use in the permalink.
    180                  * @param array    $cats Array of all categories associated with the post.
     179                 * @param WP_Term $cat  The category to use in the permalink.
     180                 * @param array    $cats Array of all categories (WP_Term objects) associated with the post.
    181181                 * @param WP_Post  $post The post in question.
    182182                 */
  • trunk/src/wp-includes/nav-menu-template.php

    r37640 r38369  
    2121 *     Optional. Array of nav menu arguments.
    2222 *
    23  *     @type string        $menu            Desired menu. Accepts (matching in order) id, slug, name. Default empty.
     23 *     @type int|string|WP_Term $menu       Desired menu. Accepts (matching in order) id, slug, name, menu object. Default empty.
    2424 *     @type string        $menu_class      CSS class to use for the ul element which forms the menu. Default 'menu'.
    2525 *     @type string        $menu_id         The ID that is applied to the ul element which forms the menu.
  • trunk/src/wp-includes/nav-menu.php

    r37752 r38369  
    1313 * @since 3.0.0
    1414 *
    15  * @param string $menu Menu ID, slug, or name - or the menu object.
    16  * @return object|false False if $menu param isn't supplied or term does not exist, menu object if successful.
     15 * @param int|string|WP_Term $menu Menu ID, slug, or name - or the menu object.
     16 * @return WP_Term|false False if $menu param isn't supplied or term does not exist, menu object if successful.
    1717 */
    1818function wp_get_nav_menu_object( $menu ) {
  • trunk/src/wp-includes/widgets/class-wp-nav-menu-widget.php

    r37489 r38369  
    7373         *     @type mixed         $menu        Menu ID, slug, or name.
    7474         * }
    75          * @param stdClass $nav_menu      Nav menu object for the current menu.
     75         * @param WP_Term $nav_menu      Nav menu object for the current menu.
    7676         * @param array    $args          Display arguments for the current widget.
    7777         * @param array    $instance      Array of settings for the current widget.
Note: See TracChangeset for help on using the changeset viewer.