wp_page_menu()

You are here:

wp_page_menu( array|string $args = array() )

Displays or retrieves a list of pages with an optional home link.

Description Description

The arguments are listed below and part of the arguments are for wp_list_pages() function. Check that function for more info on those arguments.


Top ↑

Parameters Parameters

$args

(array|string) (Optional) Array or string of arguments to generate a page menu. See wp_list_pages() for additional arguments.

  • ‘sort_column’
    (string) How to sort the list of pages. Accepts post column names. Default ‘menu_order, post_title’.
  • ‘menu_id’
    (string) ID for the div containing the page list. Default is empty string.
  • ‘menu_class’
    (string) Class to use for the element containing the page list. Default ‘menu’.
  • ‘container’
    (string) Element to use for the element containing the page list. Default ‘div’.
  • ‘echo’
    (bool) Whether to echo the list or return it. Accepts true (echo) or false (return). Default true.
  • ‘show_home’
    (int|bool|string) Whether to display the link to the home page. Can just enter the text you’d like shown for the home link. 1|true defaults to ‘Home’.
  • ‘link_before’
    (string) The HTML or text to prepend to $show_home text.
  • ‘link_after’
    (string) The HTML or text to append to $show_home text.
  • ‘before’
    (string) The HTML or text to prepend to the menu. Default is <ul>.
  • ‘after’
    (string) The HTML or text to append to the menu. Default is </ul>.
  • ‘item_spacing’
    (string) Whether to preserve whitespace within the menu’s HTML. Accepts ‘preserve’ or ‘discard’. Default ‘discard’.
  • ‘walker’
    (Walker) Walker instance to use for listing pages. Default empty (Walker_Page).

 

Default value: array()


Top ↑

Return Return

(void|string) Void if ‘echo’ argument is true, HTML menu if ‘echo’ is false.


Top ↑

Source Source

File: wp-includes/post-template.php

1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
function wp_page_menu( $args = array() ) {
    $defaults = array(
        'sort_column'  => 'menu_order, post_title',
        'menu_id'      => '',
        'menu_class'   => 'menu',
        'container'    => 'div',
        'echo'         => true,
        'link_before'  => '',
        'link_after'   => '',
        'before'       => '<ul>',
        'after'        => '</ul>',
        'item_spacing' => 'discard',
        'walker'       => '',
    );
    $args     = wp_parse_args( $args, $defaults );
 
    if ( ! in_array( $args['item_spacing'], array( 'preserve', 'discard' ), true ) ) {
        // Invalid value, fall back to default.
        $args['item_spacing'] = $defaults['item_spacing'];
    }
 
    if ( 'preserve' === $args['item_spacing'] ) {
        $t = "\t";
        $n = "\n";
    } else {
        $t = '';
        $n = '';
    }
 
    /**
     * Filters the arguments used to generate a page-based menu.
     *
     * @since 2.7.0
     *
     * @see wp_page_menu()
     *
     * @param array $args An array of page menu arguments.
     */
    $args = apply_filters( 'wp_page_menu_args', $args );
 
    $menu = '';
 
    $list_args = $args;
 
    // Show Home in the menu.
    if ( ! empty( $args['show_home'] ) ) {
        if ( true === $args['show_home'] || '1' === $args['show_home'] || 1 === $args['show_home'] ) {
            $text = __( 'Home' );
        } else {
            $text = $args['show_home'];
        }
        $class = '';
        if ( is_front_page() && ! is_paged() ) {
            $class = 'class="current_page_item"';
        }
        $menu .= '<li ' . $class . '><a href="' . home_url( '/' ) . '">' . $args['link_before'] . $text . $args['link_after'] . '</a></li>';
        // If the front page is a page, add it to the exclude list.
        if ( 'page' === get_option( 'show_on_front' ) ) {
            if ( ! empty( $list_args['exclude'] ) ) {
                $list_args['exclude'] .= ',';
            } else {
                $list_args['exclude'] = '';
            }
            $list_args['exclude'] .= get_option( 'page_on_front' );
        }
    }
 
    $list_args['echo']     = false;
    $list_args['title_li'] = '';
    $menu                 .= wp_list_pages( $list_args );
 
    $container = sanitize_text_field( $args['container'] );
 
    // Fallback in case `wp_nav_menu()` was called without a container.
    if ( empty( $container ) ) {
        $container = 'div';
    }
 
    if ( $menu ) {
 
        // wp_nav_menu() doesn't set before and after.
        if ( isset( $args['fallback_cb'] ) &&
            'wp_page_menu' === $args['fallback_cb'] &&
            'ul' !== $container ) {
            $args['before'] = "<ul>{$n}";
            $args['after']  = '</ul>';
        }
 
        $menu = $args['before'] . $menu . $args['after'];
    }
 
    $attrs = '';
    if ( ! empty( $args['menu_id'] ) ) {
        $attrs .= ' id="' . esc_attr( $args['menu_id'] ) . '"';
    }
 
    if ( ! empty( $args['menu_class'] ) ) {
        $attrs .= ' class="' . esc_attr( $args['menu_class'] ) . '"';
    }
 
    $menu = "<{$container}{$attrs}>" . $menu . "</{$container}>{$n}";
 
    /**
     * Filters the HTML output of a page-based menu.
     *
     * @since 2.7.0
     *
     * @see wp_page_menu()
     *
     * @param string $menu The HTML output.
     * @param array  $args An array of arguments.
     */
    $menu = apply_filters( 'wp_page_menu', $menu, $args );
 
    if ( $args['echo'] ) {
        echo $menu;
    } else {
        return $menu;
    }
}


Top ↑

Changelog Changelog

Changelog
VersionDescription
4.7.0Added the item_spacing argument.
4.4.0Added menu_idcontainerbeforeafter, and walker arguments.
2.7.0Introduced.
Was this article helpful?
Dislike 0
Views: 2

Cart

Log in

Create an Account
Back to Top