wp_nav_menu

函数


      wp_nav_menu ( $args = array() )

参数

(array) $args { Optional. Array of nav menu arguments. @type int|string|WP_Term $menu Desired menu. Accepts a menu ID, slug, name, or 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. Default is the menu slug, incremented. @type string $container Whether to wrap the ul, and what to wrap it with. Default 'div'. @type string $container_class Class that is applied to the container. Default 'menu-{menu slug}-container'. @type string $container_id The ID that is applied to the container. Default empty. @type string $container_aria_label The aria-label attribute that is applied to the container when it's a nav element. Default empty. @type callable|false $fallback_cb If the menu doesn't exist, a callback function will fire. Default is 'wp_page_menu'. Set to false for no fallback. @type string $before Text before the link markup. Default empty. @type string $after Text after the link markup. Default empty. @type string $link_before Text before the link text. Default empty. @type string $link_after Text after the link text. Default empty. @type bool $echo Whether to echo the menu or return it. Default true. @type int $depth How many levels of the hierarchy are to be included. 0 means all. Default 0. Default 0. @type object $walker Instance of a custom walker class. Default empty. @type string $theme_location Theme location to be used. Must be registered with register_nav_menu() in order to be selectable by the user. @type string $items_wrap How the list items should be wrapped. Uses printf() format with numbered placeholders. Default is a ul with an id and class. @type string $item_spacing Whether to preserve whitespace within the menu's HTML. Accepts 'preserve' or 'discard'. Default 'preserve'. }

Required: 否

Default: array()

返回值

(void|string|false) Void if 'echo' argument is true, menu output if 'echo' is false. False if there are no items or no menu was found.

定义位置

wp-includes/nav-menu-template.php , line 57

相关方法: is_nav_menu wp_get_nav_menus wp_nav_menu_setup wp_page_menu has_nav_menu

引入: 3.0.0

弃用: -

wp_nav_menu: 这个函数用于在WordPress中显示一个导航菜单。它接受一些参数，包括菜单位置、菜单ID以及容器和菜单类名称。

显示分类法菜单项的元框。

function wp_nav_menu( $args = array() ) {
	static $menu_id_slugs = array();

	$defaults = array(
		'menu'                 => '',
		'container'            => 'div',
		'container_class'      => '',
		'container_id'         => '',
		'container_aria_label' => '',
		'menu_class'           => 'menu',
		'menu_id'              => '',
		'echo'                 => true,
		'fallback_cb'          => 'wp_page_menu',
		'before'               => '',
		'after'                => '',
		'link_before'          => '',
		'link_after'           => '',
		'items_wrap'           => '<ul id="%1$s" class="%2$s">%3$s</ul>',
		'item_spacing'         => 'preserve',
		'depth'                => 0,
		'walker'               => '',
		'theme_location'       => '',
	);

	$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'];
	}

	/**
	 * Filters the arguments used to display a navigation menu.
	 *
	 * @since 3.0.0
	 *
	 * @see wp_nav_menu()
	 *
	 * @param array $args Array of wp_nav_menu() arguments.
	 */
	$args = apply_filters( 'wp_nav_menu_args', $args );
	$args = (object) $args;

	/**
	 * Filters whether to short-circuit the wp_nav_menu() output.
	 *
	 * Returning a non-null value from the filter will short-circuit wp_nav_menu(),
	 * echoing that value if $args->echo is true, returning that value otherwise.
	 *
	 * @since 3.9.0
	 *
	 * @see wp_nav_menu()
	 *
	 * @param string|null $output Nav menu output to short-circuit with. Default null.
	 * @param stdClass    $args   An object containing wp_nav_menu() arguments.
	 */
	$nav_menu = apply_filters( 'pre_wp_nav_menu', null, $args );

	if ( null !== $nav_menu ) {
		if ( $args->echo ) {
			echo $nav_menu;
			return;
		}

		return $nav_menu;
	}

	// Get the nav menu based on the requested menu.
	$menu = wp_get_nav_menu_object( $args->menu );

	// Get the nav menu based on the theme_location.
	$locations = get_nav_menu_locations();
	if ( ! $menu && $args->theme_location && $locations && isset( $locations[ $args->theme_location ] ) ) {
		$menu = wp_get_nav_menu_object( $locations[ $args->theme_location ] );
	}

	// Get the first menu that has items if we still can't find a menu.
	if ( ! $menu && ! $args->theme_location ) {
		$menus = wp_get_nav_menus();
		foreach ( $menus as $menu_maybe ) {
			$menu_items = wp_get_nav_menu_items( $menu_maybe->term_id, array( 'update_post_term_cache' => false ) );
			if ( $menu_items ) {
				$menu = $menu_maybe;
				break;
			}
		}
	}

	if ( empty( $args->menu ) ) {
		$args->menu = $menu;
	}

	// If the menu exists, get its items.
	if ( $menu && ! is_wp_error( $menu ) && ! isset( $menu_items ) ) {
		$menu_items = wp_get_nav_menu_items( $menu->term_id, array( 'update_post_term_cache' => false ) );
	}

	/*
	 * If no menu was found:
	 *  - Fall back (if one was specified), or bail.
	 *
	 * If no menu items were found:
	 *  - Fall back, but only if no theme location was specified.
	 *  - Otherwise, bail.
	 */
	if ( ( ! $menu || is_wp_error( $menu ) || ( isset( $menu_items ) && empty( $menu_items ) && ! $args->theme_location ) )
		&& isset( $args->fallback_cb ) && $args->fallback_cb && is_callable( $args->fallback_cb ) ) {
			return call_user_func( $args->fallback_cb, (array) $args );
	}

	if ( ! $menu || is_wp_error( $menu ) ) {
		return false;
	}

	$nav_menu = '';
	$items    = '';

	$show_container = false;
	if ( $args->container ) {
		/**
		 * Filters the list of HTML tags that are valid for use as menu containers.
		 *
		 * @since 3.0.0
		 *
		 * @param string[] $tags The acceptable HTML tags for use as menu containers.
		 *                       Default is array containing 'div' and 'nav'.
		 */
		$allowed_tags = apply_filters( 'wp_nav_menu_container_allowedtags', array( 'div', 'nav' ) );

		if ( is_string( $args->container ) && in_array( $args->container, $allowed_tags, true ) ) {
			$show_container = true;
			$class          = $args->container_class ? ' class="' . esc_attr( $args->container_class ) . '"' : ' class="menu-' . $menu->slug . '-container"';
			$id             = $args->container_id ? ' id="' . esc_attr( $args->container_id ) . '"' : '';
			$aria_label     = ( 'nav' === $args->container && $args->container_aria_label ) ? ' aria-label="' . esc_attr( $args->container_aria_label ) . '"' : '';
			$nav_menu      .= '<' . $args->container . $id . $class . $aria_label . '>';
		}
	}

	// Set up the $menu_item variables.
	_wp_menu_item_classes_by_context( $menu_items );

	$sorted_menu_items        = array();
	$menu_items_tree          = array();
	$menu_items_with_children = array();
	foreach ( (array) $menu_items as $menu_item ) {
		$sorted_menu_items[ $menu_item->menu_order ] = $menu_item;
		$menu_items_tree[ $menu_item->ID ]           = $menu_item->menu_item_parent;
		if ( $menu_item->menu_item_parent ) {
			$menu_items_with_children[ $menu_item->menu_item_parent ] = 1;
		}

		// Calculate the depth of each menu item with children
		foreach ( $menu_items_with_children as $menu_item_key => &$menu_item_depth ) {
			$menu_item_parent = $menu_items_tree[ $menu_item_key ];
			while ( $menu_item_parent ) {
				$menu_item_depth  = $menu_item_depth + 1;
				$menu_item_parent = $menu_items_tree[ $menu_item_parent ];
			}
		}
	}

	// Add the menu-item-has-children class where applicable.
	if ( $menu_items_with_children ) {
		foreach ( $sorted_menu_items as &$menu_item ) {
			if (
				isset( $menu_items_with_children[ $menu_item->ID ] ) &&
				( $args->depth <= 0 || $menu_items_with_children[ $menu_item->ID ] < $args->depth )
			) {
				$menu_item->classes[] = 'menu-item-has-children';
			}
		}
	}

	unset( $menu_items_tree, $menu_items_with_children, $menu_items, $menu_item );

	/**
	 * Filters the sorted list of menu item objects before generating the menu's HTML.
	 *
	 * @since 3.1.0
	 *
	 * @param array    $sorted_menu_items The menu items, sorted by each menu item's menu order.
	 * @param stdClass $args              An object containing wp_nav_menu() arguments.
	 */
	$sorted_menu_items = apply_filters( 'wp_nav_menu_objects', $sorted_menu_items, $args );

	$items .= walk_nav_menu_tree( $sorted_menu_items, $args->depth, $args );
	unset( $sorted_menu_items );

	// Attributes.
	if ( ! empty( $args->menu_id ) ) {
		$wrap_id = $args->menu_id;
	} else {
		$wrap_id = 'menu-' . $menu->slug;

		while ( in_array( $wrap_id, $menu_id_slugs, true ) ) {
			if ( preg_match( '#-(d+)$#', $wrap_id, $matches ) ) {
				$wrap_id = preg_replace( '#-(d+)$#', '-' . ++$matches[1], $wrap_id );
			} else {
				$wrap_id = $wrap_id . '-1';
			}
		}
	}
	$menu_id_slugs[] = $wrap_id;

	$wrap_class = $args->menu_class ? $args->menu_class : '';

	/**
	 * Filters the HTML list content for navigation menus.
	 *
	 * @since 3.0.0
	 *
	 * @see wp_nav_menu()
	 *
	 * @param string   $items The HTML list content for the menu items.
	 * @param stdClass $args  An object containing wp_nav_menu() arguments.
	 */
	$items = apply_filters( 'wp_nav_menu_items', $items, $args );
	/**
	 * Filters the HTML list content for a specific navigation menu.
	 *
	 * @since 3.0.0
	 *
	 * @see wp_nav_menu()
	 *
	 * @param string   $items The HTML list content for the menu items.
	 * @param stdClass $args  An object containing wp_nav_menu() arguments.
	 */
	$items = apply_filters( "wp_nav_menu_{$menu->slug}_items", $items, $args );

	// Don't print any markup if there are no items at this point.
	if ( empty( $items ) ) {
		return false;
	}

	$nav_menu .= sprintf( $args->items_wrap, esc_attr( $wrap_id ), esc_attr( $wrap_class ), $items );
	unset( $items );

	if ( $show_container ) {
		$nav_menu .= '</' . $args->container . '>';
	}

	/**
	 * Filters the HTML content for navigation menus.
	 *
	 * @since 3.0.0
	 *
	 * @see wp_nav_menu()
	 *
	 * @param string   $nav_menu The HTML content for the navigation menu.
	 * @param stdClass $args     An object containing wp_nav_menu() arguments.
	 */
	$nav_menu = apply_filters( 'wp_nav_menu', $nav_menu, $args );

	if ( $args->echo ) {
		echo $nav_menu;
	} else {
		return $nav_menu;
	}
}

常见问题

FAQs

钩子函数和过滤器函数的主要区别是什么？
钩子函数和过滤器函数的主要区别是它们的行为方式。钩子函数是在特定的时间点被调用的函数，它们可以执行各种任务，但通常不会返回值。而过滤器函数则是对特定的值进行过滤和修改的函数，它们会接收一个值作为输入，然后返回一个新的值作为输出。

钩子函数（Hooks）和过滤器函数（Filters）是用于修改和扩展WordPress（和其他编程环境）功能的核心概念。它们的主要区别在于它们的用途和工作方式。

1. 钩子函数（Hooks）：
- 用途：钩子函数用于在特定时机执行自定义代码。它们提供了一种将自定义功能插入到程序执行过程中的方法。
- 工作方式：主要分为两种类型，动作（Actions）和过滤器（Filters）。动作钩子允许您在特定事件发生时执行代码，而过滤器钩子允许您修改数据或结果并返回修改后的值。
2. 过滤器函数（Filters）：
- 用途：过滤器函数用于修改或过滤数据，通常是在数据输出前对其进行处理或修改。
- 工作方式：过滤器函数接受一个输入值，并返回一个经过修改后的输出值。它们可以用于修改文本、替换内容、修改HTML标记等。
主要区别在于它们的目的和使用场景：
- 钩子函数（Hooks）用于在特定事件发生时执行自定义代码，它们常用于添加新功能、执行操作或触发其他事件。它们更关注对程序执行流程的控制。
- 过滤器函数（Filters）用于修改或过滤数据，通常用于修改页面内容、数据存储或输出结果。它们更关注在给定的数据或结果上进行处理和修改。
重要的是要理解钩子函数和过滤器函数在编程环境中的作用，以便正确使用它们来实现自定义功能和修改数据。
如何使用apply_filters来应用一个过滤器函数？
apply_filters 函数用于调用一个钩子上的所有过滤器函数。它的基本用法如下：
```
$value = apply_filters( 'hook_name', $value, $var1, $var2, ... );
```
其中：

'hook_name' 是你要应用过滤器函数的钩子名称。
$value 是你要传递给过滤器函数的值。
$var1, $var2, … 是你要传递给过滤器函数的其他参数。
常量的命名规则和约定是什么？
常量的命名有一些约定和规则。首先，常量的名称应该全部大写，用下划线分隔单词。例如，MY_CONSTANT_NAME。其次，常量的名称应该是有意义的，能够清晰地描述常量的用途或值。最后，避免使用已经被PHP或WordPress定义的常量名称，以避免冲突。

在WordPress中，常量的命名规则和约定如下：
1. 全大写字母：WordPress中的常量通常以全大写字母表示，例如： ABSPATH 。
2. 使用下划线分隔单词：常量的单词之间使用下划线 _ 进行分隔，例如： WP_DEBUG .
3. 常量的前缀：建议为常量添加一个特定的前缀以避免与其他常量或变量发生冲突。例如，WordPress核心常量通常使用前缀 WP_ ，例如： WP_CONTENT_DIR 。
4. 描述性命名：常量的名称应该具有描述性，以便能够清楚地表达其用途和含义。这有助于提高代码的可读性和可维护性。
5. 避免硬编码：常量的作用是提供一个不可更改的值，因此应避免在代码中直接硬编码常量的值。相反，应该通过定义常量并赋予其一个有意义的值来使用它们。
例如，以下是符合WordPress常量命名规则的示例：
```
define( 'WP_DEBUG', true );
define( 'WP_CONTENT_DIR', '/var/www/html/wp-content' );
define( 'MY_CUSTOM_CONSTANT', 'Hello World' );
```
遵循这些命名规则和约定可以帮助保持代码的一致性和可读性，使得WordPress主题或插件更易于理解、维护和扩展。
如何使用WordPress REST API？
要使用WordPress REST API，可以按照以下步骤进行操作：
1. 检查WordPress版本：确保你使用的WordPress版本在4.7或更高，因为REST API是从该版本开始集成到WordPress核心中的。
2. 启用REST API：默认情况下，WordPress REST API已经启用。如果你需要确认是否启用，可以访问WordPress的后台管理页面，转到“设置” > “固定链接” ，然后确保“常规设置”中的“启用REST API”选项被勾选。
3. 授权和身份验证：REST API通常需要进行身份验证。你可以使用OAuth、基本身份验证（用户名和密码）或cookie进行身份验证。根据你的需求选择合适的身份验证方式。
4. 使用REST API终点：WordPress REST API提供了各种终点（endpoints），用于执行不同的操作，如检索帖子、页面、分类目录、评论等。你可以通过GET、POST、PUT、DELETE等请求方法与这些终点进行交互。
  - 例如，要获取帖子列表，可以发出GET请求到`/wp-json/wp/v2/posts`。
  - 要获取特定帖子的详细信息，例如ID为1的帖子，可以发出GET请求到`/wp-json/wp/v2/posts/1`。
  - 要创建新的帖子，可以发出POST请求到`/wp-json/wp/v2/posts`并提供所需的参数。
5. 处理响应数据：REST API通常返回JSON格式的数据。你可以使用编程语言、HTTP客户端或浏览器工具来处理和解析返回的JSON数据。
这些是使用WordPress REST API的基本步骤。你可以根据具体需求进行深入学习和实践，探索更多可用的终点和功能。对于详细的API文档和参考，请查阅WordPress官方文档或REST API官方手册。
钩子函数可以在哪些地方使用？
在WordPress中，钩子函数可以在以下几个地方使用：
1. 插件（Plugins）：WordPress的插件是一种扩展机制，允许开发者在WordPress的核心功能之上添加自定义功能。插件可以使用钩子函数来注册和处理特定的WordPress事件或动作。例如，可以使用`add_action()`函数来注册在特定动作点（action hooks）上执行的钩子函数，或使用` add_filter() `函数注册在特定过滤器（filter hooks）上执行的钩子函数。
2. 主题（Themes）：WordPress的主题是用于控制网站外观和功能的模板系统。开发者可以在主题中使用钩子函数来修改主题输出的内容或行为。例如，可以使用` add_action() `函数在特定的动作点上添加自定义内容，或使用` add_filter() `函数修改主题函数的输出。
3. 自定义功能文件（Custom Functions File）：可以在主题文件夹或子主题文件夹中创建一个名为` functions.php `的文件，用于添加自定义功能和修改WordPress行为。该文件中可以使用钩子函数来注册特定的动作点和过滤器，并添加相应的钩子函数来处理这些事件。
4. WordPress核心文件：尽管不推荐修改WordPress核心文件，但在某些情况下，可以通过修改核心文件的方式使用钩子函数。例如，可以在WordPress核心文件中的特定位置添加自定义的` do_action() `或` apply_filters() `函数调用，然后在需要的地方注册相应的钩子函数。
总结起来，WordPress中的钩子函数可以在插件、主题、自定义功能文件以及WordPress核心文件中使用，用于注册和处理特定的WordPress事件或动作。这允许开发者在这些地方插入自定义逻辑，以实现个性化的功能和修改WordPress的行为。
如何使用wp_insert_post插入新的文章？
wp_insert_post() 函数用于插入新的文章。你需要传递一个关联数组，包含文章的各项参数，如标题、内容、分类等。例如：
```
$post_data = array(  
    'post_title' => '新的文章',  
    'post_content' => '这是一篇新的文章。',  
    'post_status' => 'publish', // 设置为 'publish' 以立即发布文章  
    'post_type' => 'post', // 也可以设置为 'page' 或其他自定义的文章类型  
);  
$post_id = wp_insert_post($post_data);
```
如果你想要插入更复杂的文章，例如包含多个分类或标签，你可以在 $post_data 数组中添加更多的键值对。

wp_nav_menu

常见问题

相关文章