WP_Admin_Bar::add_node( array $args )

Compatibility

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

Parameters

$argsarray

Arguments for adding a node.

• $idstring

  ID of the item.

• $titlestring

  Title of the node.

• $parentstring

  Optional. ID of the parent node.

• $hrefstring

  Optional. Link for the item.

• $groupbooldefault: false

  Optional. Whether or not the node is a group.

• $metaarraydefault: empty

  Meta data including the following keys: 'html', 'class', 'rel', 'lang', 'dir', 'onclick', 'target', 'title', 'tabindex', 'menu_title'.

Performance profile

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

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

11–102

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

Plugin surface

None

Nothing here hands control to plugin code.

Called by

3

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

What it touches

• hookthird-party callbacksdo_action()one call below WP_Admin_Bar::add_node()

Further down the call graph this can also reach option, cache, serialize, 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 · 68 distinct outcomes

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

Uses · 8

• _doing_it_wrong()Marks something as being incorrectly called.
• __()Retrieves the translation of $text.
• esc_attr()Escaping for HTML attributes.
• sanitize_title()Sanitizes a string into a slug, which can be used in URLs or HTML attributes.
• wp_parse_args()Merges user defined arguments into defaults array.
• _deprecated_argument()Marks a function argument as deprecated and inform when it has been used.
• WP_Admin_Bar::get_node()Gets a node.
• WP_Admin_Bar::_set_node()

Used by · 3

• WP_Admin_Bar::_bind()
• WP_Admin_Bar::add_group()Adds a group to a toolbar menu node.
• WP_Admin_Bar::add_menu()Adds a node (menu item) to the admin bar menu.

Source code

View on Trac ↗View on GitHub ↗

124	public function add_node( $args ) {125		// Shim for old method signature: add_node( $parent_id, $menu_obj, $args ).126		if ( func_num_args() >= 3 && is_string( $args ) ) {127			$args = array_merge( array( 'parent' => $args ), func_get_arg( 2 ) );128		}129 130		if ( is_object( $args ) ) {131			$args = get_object_vars( $args );132		}133 134		// Ensure we have a valid title.135		if ( empty( $args['id'] ) ) {136			if ( empty( $args['title'] ) ) {137				return;138			}139 140			_doing_it_wrong( __METHOD__, __( 'The menu ID should not be empty.' ), '3.3.0' );141			// Deprecated: Generate an ID from the title.142			$args['id'] = esc_attr( sanitize_title( trim( $args['title'] ) ) );143		}144 145		$defaults = array(146			'id'     => false,147			'title'  => false,148			'parent' => false,149			'href'   => false,150			'group'  => false,151			'meta'   => array(),152		);153 154		// If the node already exists, keep any data that isn't provided.155		$maybe_defaults = $this->get_node( $args['id'] );156		if ( $maybe_defaults ) {157			$defaults = get_object_vars( $maybe_defaults );158		}159 160		// Do the same for 'meta' items.161		if ( ! empty( $defaults['meta'] ) && ! empty( $args['meta'] ) ) {162			$args['meta'] = wp_parse_args( $args['meta'], $defaults['meta'] );163		}164 165		$args = wp_parse_args( $args, $defaults );166 167		$back_compat_parents = array(168			'my-account-with-avatar' => array( 'my-account', '3.3' ),169			'my-blogs'               => array( 'my-sites', '3.3' ),170		);171 172		if ( isset( $back_compat_parents[ $args['parent'] ] ) ) {173			list( $new_parent, $version ) = $back_compat_parents[ $args['parent'] ];174			_deprecated_argument( __METHOD__, $version, sprintf( 'Use <code>%s</code> as the parent for the <code>%s</code> admin bar node instead of <code>%s</code>.', $new_parent, $args['id'], $args['parent'] ) );175			$args['parent'] = $new_parent;176		}177 178		$this->_set_node( $args );179	}

Changelog

Introduced in 3.1.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-admin-bar.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.