WP_Customize_Nav_Menus::load_available_items_query( string $object_type = 'post_type', string $object_name = 'page', int $page = 0 ): array|WP_Error

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$object_typestringoptional

Accepts any custom object type and has built-in support for 'post_type' and 'taxonomy'. Default is 'post_type'.Default: 'post_type'

$object_namestringoptional

Accepts any registered taxonomy or post type name. Default is 'page'.Default: 'page'

$pageintoptional

The page number used to generate the query offset. Default is '0'.Default: 0

Return value

array|WP_Error

An array of menu items on success, a WP_Error object on failure.

Performance profile

How much work a call to WP_Customize_Nav_Menus::load_available_items_query() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Heavy

Reaches the database via get_post().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

17–140

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 317.

Plugin surface

1 hook

Third-party callbacks on 'customize_nav_menu_available_items' run inside this call, and their cost is not bounded by anything here.

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• optionoption read or writeget_option()called directly
• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_get()one call below WP_Customize_Nav_Menus::load_available_items_query()
• serializeserialisationmaybe_unserialize()one call below WP_Customize_Nav_Menus::load_available_items_query()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 105 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_Customize_Nav_Menus::load_available_items_query() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 1

One hook fires while WP_Customize_Nav_Menus::load_available_items_query() runs, in this order:

1. 1
   apply_filters( customize_nav_menu_available_items )filterline 307 (+166 into the body)

   Filters the available menu items.

Uses · 17

• get_post_type_object()Retrieves a post type object by name.
• get_option()Retrieves an option value based on an option name.
• get_post()Retrieves post data given a post ID or post object.
• _x()Retrieves translated string with gettext context.
• __()Retrieves the translation of $text.
• home_url()Retrieves the URL for the current site where the front end is accessible.
• get_post_type_archive_link()Retrieves the permalink for a post type archive.
• get_posts()Retrieves an array of the latest posts, or posts matching the given criteria.
• get_post_states()Retrieves an array of post states from a post.
• get_bloginfo()Retrieves information about the current site.
• get_permalink()Retrieves the full permalink for the current post or post ID.
• get_terms()Retrieves the terms in a given taxonomy or list of taxonomies.

Used by · 1

• WP_Customize_Nav_Menus::ajax_load_available_items()Ajax handler for loading available menu items.

Source code

View on Trac ↗View on GitHub ↗

141	public function load_available_items_query( $object_type = 'post_type', $object_name = 'page', $page = 0 ) {142		$items = array();143 144		if ( 'post_type' === $object_type ) {145			$post_type = get_post_type_object( $object_name );146			if ( ! $post_type ) {147				return new WP_Error( 'nav_menus_invalid_post_type' );148			}149 150			/*151			 * If we're dealing with pages, let's prioritize the Front Page,152			 * Posts Page and Privacy Policy Page at the top of the list.153			 */154			$important_pages   = array();155			$suppress_page_ids = array();156			if ( 0 === $page && 'page' === $object_name ) {157				// Insert Front Page or custom "Home" link.158				$front_page = 'page' === get_option( 'show_on_front' ) ? (int) get_option( 'page_on_front' ) : 0;159				if ( ! empty( $front_page ) ) {160					$front_page_obj      = get_post( $front_page );161					$important_pages[]   = $front_page_obj;162					$suppress_page_ids[] = $front_page_obj->ID;163				} else {164					// Add "Home" link. Treat as a page, but switch to custom on add.165					$items[] = array(166						'id'         => 'home',167						'title'      => _x( 'Home', 'nav menu home label' ),168						'type'       => 'custom',169						'type_label' => __( 'Custom Link' ),170						'object'     => '',171						'url'        => home_url(),172					);173				}174 175				// Insert Posts Page.176				$posts_page = 'page' === get_option( 'show_on_front' ) ? (int) get_option( 'page_for_posts' ) : 0;177				if ( ! empty( $posts_page ) ) {178					$posts_page_obj      = get_post( $posts_page );179					$important_pages[]   = $posts_page_obj;180					$suppress_page_ids[] = $posts_page_obj->ID;181				}182 183				// Insert Privacy Policy Page.184				$privacy_policy_page_id = (int) get_option( 'wp_page_for_privacy_policy' );185				if ( ! empty( $privacy_policy_page_id ) ) {186					$privacy_policy_page = get_post( $privacy_policy_page_id );187					if ( $privacy_policy_page instanceof WP_Post && 'publish' === $privacy_policy_page->post_status ) {188						$important_pages[]   = $privacy_policy_page;189						$suppress_page_ids[] = $privacy_policy_page->ID;190					}191				}192			} elseif ( 'post' !== $object_name && 0 === $page && $post_type->has_archive ) {193				// Add a post type archive link.194				$title   = $post_type->labels->archives;195				$items[] = array(196					'id'             => $object_name . '-archive',197					'title'          => $title,198					'original_title' => $title,199					'type'           => 'post_type_archive',200					'type_label'     => __( 'Post Type Archive' ),201					'object'         => $object_name,202					'url'            => get_post_type_archive_link( $object_name ),203				);204			}205 206			// Prepend posts with nav_menus_created_posts on first page.207			$posts = array();208			if ( 0 === $page && $this->manager->get_setting( 'nav_menus_created_posts' ) ) {209				foreach ( $this->manager->get_setting( 'nav_menus_created_posts' )->value() as $post_id ) {210					$auto_draft_post = get_post( $post_id );211					if ( $post_type->name === $auto_draft_post->post_type ) {212						$posts[] = $auto_draft_post;213					}214				}215			}216 217			$args = array(218				'numberposts' => 10,219				'offset'      => 10 * $page,220				'orderby'     => 'date',

Changelog

Introduced in 4.3.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/class-wp-customize-nav-menus.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.