WordPress.org

Make WordPress Core

Ticket #23627: 23627.diff

File 23627.diff, 1.1 KB (added by DrewAPicture, 5 years ago)

hook docs tweaks

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

     
    231231        $args = apply_filters( 'wp_nav_menu_args', $args );
    232232        $args = (object) $args;
    233233
     234        /**
     235         * Filter whether to preempt the wp_nav_menu() output.
     236         *
     237         * Returning a non-null value to the filter will short-circuit
     238         * wp_nav_menu(), echoing that value if $args->echo is true,
     239         * returning that value otherwise.
     240         *
     241         * @since 3.9.0
     242         *
     243         * @see wp_nav_menu()
     244         *
     245         * @param string|null $output Nav menu output to short-circuit with. Default null.
     246         * @param object      $args   An object containing wp_nav_menu() arguments.
     247         */
     248        $nav_menu = apply_filters( 'pre_wp_nav_menu', null, $args );
     249
     250        if ( $nav_menu !== null && $args->echo ) {
     251                echo $nav_menu;
     252                return;
     253        } elseif ( $nav_menu !== null ) {
     254                return $nav_menu;
     255        }
     256
    234257        // Get the nav menu based on the requested menu
    235258        $menu = wp_get_nav_menu_object( $args->menu );
    236259