WordPress.org

Make WordPress Core

Changeset 27700


Ignore:
Timestamp:
03/25/14 09:03:02 (4 years ago)
Author:
DrewAPicture
Message:

Inline documentation for hooks in wp-includes/nav-menu.php.

Props dustyf, kpdesign.
Fixes #27367.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/nav-menu.php

    r27556 r27700  
    202202 
    203203    if ( $result && !is_wp_error($result) ) 
     204 
     205        /** 
     206         * Fires after a navigation menu has been successfully deleted. 
     207         * 
     208         * @since 3.0.0 
     209         * 
     210         * @param int $term_id ID of the deleted menu. 
     211         */ 
    204212        do_action( 'wp_delete_nav_menu', $menu->term_id ); 
    205213 
     
    214222 * @param int $menu_id The ID of the menu or "0" to create a new menu. 
    215223 * @param array $menu_data The array of menu data. 
    216  * @return int|error object The menu's ID or WP_Error object. 
     224 * @return int|WP_Error object The menu's ID or WP_Error object. 
    217225 */ 
    218226function wp_update_nav_menu_object( $menu_id = 0, $menu_data = array() ) { 
     
    250258            return $_menu; 
    251259 
     260        /** 
     261         * Fires after a navigation menu is successfully created. 
     262         * 
     263         * @since 3.0.0 
     264         * 
     265         * @param int   $term_id   ID of the new menu. 
     266         * @param array $menu_data An array of menu data. 
     267         */ 
    252268        do_action( 'wp_create_nav_menu', $_menu['term_id'], $menu_data ); 
    253269 
     
    265281        return $update_response; 
    266282 
     283    /** 
     284     * Fires after a navigation menu has been successfully updated. 
     285     * 
     286     * @since 3.0.0 
     287     * 
     288     * @param int   $menu_id   ID of the updated menu. 
     289     * @param array $menu_data An array of menu data. 
     290     */ 
    267291    do_action( 'wp_update_nav_menu', $menu_id, $menu_data ); 
    268292    return $menu_id; 
     
    412436    } 
    413437 
    414     do_action('wp_update_nav_menu_item', $menu_id, $menu_item_db_id, $args ); 
     438    /** 
     439     * Fires after a navigation menu item has been updated. 
     440     * 
     441     * @since 3.0.0 
     442     * 
     443     * @see wp_update_nav_menu_items() 
     444     * 
     445     * @param int   $menu_id         ID of the updated menu. 
     446     * @param int   $menu_item_db_id ID of the updated menu item. 
     447     * @param array $args            An array of arguments used to update a menu item. 
     448     */ 
     449    do_action( 'wp_update_nav_menu_item', $menu_id, $menu_item_db_id, $args ); 
    415450 
    416451    return $menu_item_db_id; 
     
    428463    $defaults = array( 'hide_empty' => false, 'orderby' => 'none' ); 
    429464    $args = wp_parse_args( $args, $defaults ); 
     465 
     466    /** 
     467     * Filter the navigation menu objects being returned. 
     468     * 
     469     * @since 3.0.0 
     470     * 
     471     * @see get_terms() 
     472     * 
     473     * @param array $menus An array of menu objects. 
     474     * @param array $args  An array of arguments used to retrieve menu objects. 
     475     */ 
    430476    return apply_filters( 'wp_get_nav_menus', get_terms( 'nav_menu',  $args), $args ); 
    431477} 
     
    557603    } 
    558604 
     605    /** 
     606     * Filter the navigation menu items being returned. 
     607     * 
     608     * @since 3.0.0 
     609     * 
     610     * @param array  $items An array of menu item post objects. 
     611     * @param object $menu  The menu object. 
     612     * @param array  $args  An array of arguments used to retrieve menu item objects. 
     613     */ 
    559614    return apply_filters( 'wp_get_nav_menu_items',  $items, $menu, $args ); 
    560615} 
     
    633688            $menu_item->target = empty( $menu_item->target ) ? get_post_meta( $menu_item->ID, '_menu_item_target', true ) : $menu_item->target; 
    634689 
     690            /** 
     691             * Filter a navigation menu item's title attribute. 
     692             * 
     693             * @since 3.0.0 
     694             * 
     695             * @param string $item_title The menu item title attribute. 
     696             */ 
    635697            $menu_item->attr_title = empty( $menu_item->attr_title ) ? apply_filters( 'nav_menu_attr_title', $menu_item->post_excerpt ) : $menu_item->attr_title; 
    636698 
    637             if ( empty( $menu_item->description ) ) 
    638                 $menu_item->description = apply_filters( 'nav_menu_description',  wp_trim_words( $menu_item->post_content, 200 ) ); 
     699            if ( empty( $menu_item->description ) ) { 
     700                /** 
     701                 * Filter a navigation menu item's description. 
     702                 * 
     703                 * @since 3.0.0 
     704                 * 
     705                 * @param string $description The menu item description. 
     706                 */ 
     707                $menu_item->description = apply_filters( 'nav_menu_description', wp_trim_words( $menu_item->post_content, 200 ) ); 
     708            } 
    639709 
    640710            $menu_item->classes = empty( $menu_item->classes ) ? (array) get_post_meta( $menu_item->ID, '_menu_item_classes', true ) : $menu_item->classes; 
     
    657727            $menu_item->target = ''; 
    658728 
     729            /** This filter is documented in wp-includes/nav-menu.php */ 
    659730            $menu_item->attr_title = apply_filters( 'nav_menu_attr_title', '' ); 
     731 
     732            /** This filter is documented in wp-includes/nav-menu.php */ 
    660733            $menu_item->description = apply_filters( 'nav_menu_description', '' ); 
    661734            $menu_item->classes = array(); 
     
    684757    } 
    685758 
     759    /** 
     760     * Filter a navigation menu item object. 
     761     * 
     762     * @since 3.0.0 
     763     * 
     764     * @param object $menu_item The menu item object. 
     765     */ 
    686766    return apply_filters( 'wp_setup_nav_menu_item', $menu_item ); 
    687767} 
Note: See TracChangeset for help on using the changeset viewer.