wppaste
WordPress

_wp_auto_add_pages_to_menu( string $new_status, string $old_status, WP_Post $post )

Since
3.0.0
Source
wp-includes/nav-menu.php:1137
Automatically add newly published page objects to menus with that as an option.

Compatibility

WordPress
since 3.0.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$new_statusstring
The new status of the post object.
$old_statusstring
The old status of the post object.
$postWP_Post
The post object being transitioned from one status to another.

Performance profile

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

Scaling
Scales with input

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

Instructions
6–39

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • optionoption read or writeget_option()called directly
  • hookthird-party callbacksapply_filters()one call below _wp_auto_add_pages_to_menu()
  • cacheobject cachewp_cache_get()one call below _wp_auto_add_pages_to_menu()
  • serializeserialisationmaybe_unserialize()one call below _wp_auto_add_pages_to_menu()
  • querycontent queryget_posts()one call below _wp_auto_add_pages_to_menu()

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 · 2 distinct outcomes

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

WhenInstructionsCalls it makes
always6–13none
$new_status === "publish" && $old_status !== "publish" && empty($post)19–39get_option()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 66 instructions, 6–39 executed per call, 15 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 3

Source code

function _wp_auto_add_pages_to_menu( $new_status, $old_status, $post ) {	if ( 'publish' !== $new_status || 'publish' === $old_status || 'page' !== $post->post_type ) {		return;	}	if ( ! empty( $post->post_parent ) ) {		return;	}	$auto_add = get_option( 'nav_menu_options' );	if ( empty( $auto_add ) || ! is_array( $auto_add ) || ! isset( $auto_add['auto_add'] ) ) {		return;	}	$auto_add = $auto_add['auto_add'];	if ( empty( $auto_add ) || ! is_array( $auto_add ) ) {		return;	} 	$args = array(		'menu-item-object-id' => $post->ID,		'menu-item-object'    => $post->post_type,		'menu-item-type'      => 'post_type',		'menu-item-status'    => 'publish',	); 	foreach ( $auto_add as $menu_id ) {		$items = wp_get_nav_menu_items( $menu_id, array( 'post_status' => 'publish,draft' ) );		if ( ! is_array( $items ) ) {			continue;		}		foreach ( $items as $item ) {			if ( $post->ID === (int) $item->object_id ) {				continue 2;			}		}		wp_update_nav_menu_item( $menu_id, 0, $args );	}}

Changelog

Introduced in 3.0.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 7.1.0 tag, from src/wp-includes/nav-menu.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.