функция since 3.0.0

wp_get_nav_menu_items()

Проверено на WordPress 6.9, обновлено Источник: WordPress Developer Resources.

Сигнатура

wp_get_nav_menu_items( int|string|WP_Term $menu, array $args = array() ): array|false

Описание

Примечание: большинство аргументов, передаваемых в параметр $args (кроме 'output_key'), предназначены именно для получения записей nav_menu_item из get_posts() и могут лишь косвенно влиять на итоговый порядок и содержимое элементов меню навигации, возвращаемых этой функцией.

Оригинал (английский)

Note: Most arguments passed to the $args parameter – save for ‘output_key’ – are specifically for retrieving nav_menu_item posts from get_posts() and may only indirectly affect the ultimate ordering and content of the resulting nav menu items that get returned from this function.

Параметры

$menu int|string|WP_Term обязательный
ID меню, слаг, имя или объект.
$args array необязательный = array()
Аргументы для передачи в get_posts() . order stringКак упорядочить элементы меню навигации при запросе через get_posts() . Будет проигнорировано, если 'output' равно ARRAY_A. По умолчанию 'ASC'. orderby stringПоле, по которому упорядочиваются элементы меню при получении из get_posts() . Укажите поле сортировки через 'output_key', чтобы повлиять на порядок вывода элементов меню навигации. По умолчанию 'menu_order'. post_type stringТип записи элементов меню. По умолчанию 'nav_menu_item'. post_status stringСтатус записи элементов меню. По умолчанию 'publish'. output stringКак упорядочить выводимые элементы меню. По умолчанию ARRAY_A. output_key stringКлюч, используемый для упорядочивания фактически возвращаемых элементов меню. Обратите внимание, что это не аргумент get_posts() и он влияет только на вывод элементов меню, обработанных этой функцией. По умолчанию 'menu_order'. nopaging boolПолучать все элементы меню (true) или разбивать на страницы (false). По умолчанию true. update_menu_item_cache boolОбновлять ли кэш элементов меню. По умолчанию true.

Возвращаемое значение

array|false

Исходный код

wp-includes/nav-menu.php:712

function wp_get_nav_menu_items( $menu, $args = array() ) {
	$menu = wp_get_nav_menu_object( $menu );

	if ( ! $menu ) {
		return false;
	}

	if ( ! taxonomy_exists( 'nav_menu' ) ) {
		return false;
	}

	$defaults = array(
		'order'                  => 'ASC',
		'orderby'                => 'menu_order',
		'post_type'              => 'nav_menu_item',
		'post_status'            => 'publish',
		'output'                 => ARRAY_A,
		'output_key'             => 'menu_order',
		'nopaging'               => true,
		'update_menu_item_cache' => true,
		'tax_query'              => array(
			array(
				'taxonomy' => 'nav_menu',
				'field'    => 'term_taxonomy_id',
				'terms'    => $menu->term_taxonomy_id,
			),
		),
	);
	$args     = wp_parse_args( $args, $defaults );
	if ( $menu->count > 0 ) {
		$items = get_posts( $args );
	} else {
		$items = array();
	}

	$items = array_map( 'wp_setup_nav_menu_item', $items );

	if ( ! is_admin() ) { // Remove invalid items only on front end.
		$items = array_filter( $items, '_is_valid_nav_menu_item' );
	}

	if ( ARRAY_A === $args['output'] ) {
		$items = wp_list_sort(
			$items,
			array(
				$args['output_key'] => 'ASC',
			)
		);

		$i = 1;

		foreach ( $items as $k => $item ) {
			$items[ $k ]->{$args['output_key']} = $i++;
		}
	}

	/**
	 * Filters the navigation menu items being returned.
	 *
	 * @since 3.0.0
	 *
	 * @param array  $items An array of menu item post objects.
	 * @param object $menu  The menu object.
	 * @param array  $args  An array of arguments used to retrieve menu item objects.
	 */
	return apply_filters( 'wp_get_nav_menu_items', $items, $menu, $args );
}

История изменений

ВерсияОписание
3.0.0 Introduced.

Что будем искать? Например,Продвижение

Этот сайт использует куки-файлы. Оставаясь на сайте, Вы соглашаетесь на их использование. Для получения дополнительной информации, пожалуйста, ознакомьтесь с политикой в отношении персональных данных.