block_core_page_list_render_nested_page_list( string $submenu_visibility, boolean $show_submenu_icons, boolean $is_navigation_child, array $nested_pages, boolean $is_nested, array $active_page_ancestor_ids = array(), array $colors = array(), integer $depth = 0 ): string

Compatibility

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

Parameters

$submenu_visibilitystring

The submenu visibility mode: 'hover', 'click', or 'always'.

$show_submenu_iconsboolean

Whether to show submenu indicator icons.

$is_navigation_childboolean

If block is a child of Navigation block.

$nested_pagesarray

The array of nested pages.

$is_nestedboolean

Whether the submenu is nested or not.

$active_page_ancestor_idsarrayoptional

An array of ancestor ids for active page.Default: array()

$colorsarrayoptional

Color information for overlay styles.Default: array()

$depthintegeroptional

The nesting depth.Default: 0

Return value

string

List markup.

Performance profile

How much work a call to block_core_page_list_render_nested_page_list() 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

Reads stored settings via get_option(), cached per request but not free on a cold cache.

Scaling

Scales with input

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

Instructions

22–23

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

2

2 places 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
• hookthird-party callbacksapply_filters()one call below block_core_page_list_render_nested_page_list()
• cacheobject cachewp_cache_get()one call below block_core_page_list_render_nested_page_list()
• serializeserialisationmaybe_unserialize()one call below block_core_page_list_render_nested_page_list()

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

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost block_core_page_list_render_nested_page_list() 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.

Uses · 7

• get_option()Retrieves an option value based on an option name.
• esc_attr()Escaping for HTML attributes.
• __()Retrieves the translation of $text.
• wp_strip_all_tags()Properly strips all HTML tags including 'script' and 'style'.
• wp_kses_post()Sanitizes content for allowed HTML tags for post content.
• esc_url()Checks and cleans a URL.
• block_core_page_list_render_nested_page_list()Outputs Page list markup from an array of pages with nested children.

Used by · 2

• block_core_page_list_render_nested_page_list()Outputs Page list markup from an array of pages with nested children.
• render_block_core_page_list()Renders the `core/page-list` block on server.

Source code

View on Trac ↗View on GitHub ↗

142function block_core_page_list_render_nested_page_list( $submenu_visibility, $show_submenu_icons, $is_navigation_child, $nested_pages, $is_nested, $active_page_ancestor_ids = array(), $colors = array(), $depth = 0 ) {143	if ( empty( $nested_pages ) ) {144		return;145	}146	$front_page_id = (int) get_option( 'page_on_front' );147	$markup        = '';148 149	// Compute visibility mode flags once150	$open_on_click = 'click' === $submenu_visibility;151	$open_on_hover = 'hover' === $submenu_visibility;152	$open_always   = 'always' === $submenu_visibility;153 154	foreach ( (array) $nested_pages as $page ) {155		$css_class       = $page['is_active'] ? ' current-menu-item' : '';156		$aria_current    = $page['is_active'] ? ' aria-current="page"' : '';157		$style_attribute = '';158 159		$css_class .= in_array( $page['page_id'], $active_page_ancestor_ids, true ) ? ' current-menu-ancestor' : '';160		if ( isset( $page['children'] ) ) {161			$css_class .= ' has-child';162		}163 164		if ( $is_navigation_child ) {165			$css_class .= ' wp-block-navigation-item';166 167			// Class assignment logic matches JS editor rendering in page-list-item/edit.js168			// Note: elseif ensures open-on-hover-click is mutually exclusive with open-on-click169			if ( $open_on_click ) {170				$css_class .= ' open-on-click';171			} elseif ( $open_on_hover && $show_submenu_icons ) {172				$css_class .= ' open-on-hover-click';173			} elseif ( $open_always ) {174				$css_class .= ' open-always';175			}176		}177 178		$navigation_child_content_class = $is_navigation_child ? ' wp-block-navigation-item__content' : '';179 180		// If this is the first level of submenus, include the overlay colors.181		if ( ( ( 0 < $depth && ! $is_nested ) || $is_nested ) && isset( $colors['overlay_css_classes'], $colors['overlay_inline_styles'] ) ) {182			$css_class .= ' ' . trim( implode( ' ', $colors['overlay_css_classes'] ) );183			if ( '' !== $colors['overlay_inline_styles'] ) {184				$style_attribute = sprintf( ' style="%s"', esc_attr( $colors['overlay_inline_styles'] ) );185			}186		}187 188		if ( (int) $page['page_id'] === $front_page_id ) {189			$css_class .= ' menu-item-home';190		}191 192		$title = $page['title'] ? $page['title'] : __( '(no title)' );193 194		$aria_label = sprintf(195			/* translators: Accessibility text. %s: Parent page title. */196			__( '%s submenu' ),197			wp_strip_all_tags( $title )198		);199 200		$markup .= '<li class="wp-block-pages-list__item' . esc_attr( $css_class ) . '"' . $style_attribute . '>';201 202		if ( isset( $page['children'] ) && $is_navigation_child && $open_on_click ) {203			$markup .= '<button aria-label="' . esc_attr( $aria_label ) . '" class="' . esc_attr( $navigation_child_content_class ) . ' wp-block-navigation-submenu__toggle" aria-expanded="false">' . wp_kses_post( $title ) .204			'</button><span class="wp-block-page-list__submenu-icon wp-block-navigation__submenu-icon"><svg xmlns="http://www.w3.org/2000/svg" width="12" height="12" viewBox="0 0 12 12" fill="none" aria-hidden="true" focusable="false"><path d="M1.50002 4L6.00002 8L10.5 4" stroke-width="1.5"></path></svg></span>';205		} else {206			$markup .= '<a class="wp-block-pages-list__item__link' . esc_attr( $navigation_child_content_class ) . '" href="' . esc_url( $page['link'] ) . '"' . $aria_current . '>' . wp_kses_post( $title ) . '</a>';207		}208 209		if ( isset( $page['children'] ) ) {210			if ( $is_navigation_child && $show_submenu_icons && ! $open_on_click ) {211				$markup .= '<button aria-label="' . esc_attr( $aria_label ) . '" class="wp-block-navigation__submenu-icon wp-block-navigation-submenu__toggle" aria-expanded="false">';212				$markup .= '<svg xmlns="http://www.w3.org/2000/svg" width="12" height="12" viewBox="0 0 12 12" fill="none" aria-hidden="true" focusable="false"><path d="M1.50002 4L6.00002 8L10.5 4" stroke-width="1.5"></path></svg>';213				$markup .= '</button>';214			}215			$markup .= '<ul class="wp-block-navigation__submenu-container">';216			$markup .= block_core_page_list_render_nested_page_list( $submenu_visibility, $show_submenu_icons, $is_navigation_child, $page['children'], $is_nested, $active_page_ancestor_ids, $colors, $depth + 1 );217			$markup .= '</ul>';218		}219		$markup .= '</li>';220	}221	return $markup;

Changelog

Introduced in 5.8.0. 3 changes between 6.7.7 and 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 7.1.0 tag, from src/wp-includes/blocks/page-list.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.