wp_get_tooltip_helper( string $content, array $args = array() ): string

Description

Compatibility

Present in 1 of the 5 tracked releases, added in 7.1.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$contentstring

Plain-text tooltip content. An empty value returns an empty string.

$argsarrayoptional

Arguments for building the tooltip.Default: array()

• $idstringdefault: is a generated unique ID

  Unique ID for the popover element.

• $buttonstringdefault: standard button HTML

  Existing button or a markup. Used instead of generated button.

• $labelstringdefault: 'Help', matching the default icon. Ignored for tooltips

  Accessible label for the toggle button.

• $close_labelstringdefault: 'Close'

  Accessible label for the close button.

• $iconstringdefault: 'dashicons-editor-help'. Should match the control's visible label

  Dashicons icon class for the toggle button.

• $classstringdefault: empty

  Additional class(es) for the wrapping element.

• $typestringdefault: 'tooltip'

  Type of tooltip: either tooltip or toggletip.

Return value

string

Tooltip HTML markup, or an empty string when no content is provided.

Performance profile

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

8–148

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

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

• hookthird-party callbacksapply_filters()one call below wp_get_tooltip_helper()

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

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

Uses · 7

• wp_unique_id()Gets unique ID.
• __()Retrieves the translation of $text.
• wp_parse_args()Merges user defined arguments into defaults array.
• wp_strip_all_tags()Properly strips all HTML tags including 'script' and 'style'.
• esc_attr()Escaping for HTML attributes.
• esc_html()Escaping for HTML blocks.
• WP_HTML_Tag_Processor::__construct()Constructor.

Used by · 2

• wp_get_toggletip()Retrieves the markup for an accessible toggle tip.
• wp_get_tooltip()Retrieves the markup for an accessible tooltip.

Source code

View on Trac ↗View on GitHub ↗

467function wp_get_tooltip_helper( $content, $args = array() ) {468	$content = trim( (string) $content );469 470	if ( '' === $content ) {471		return '';472	}473 474	$defaults = array(475		'id'          => wp_unique_id( 'wp-tooltip-' ),476		'button'      => '<button type="button" aria-label="%3$s"><span class="dashicons %4$s" aria-hidden="true"></span></button>',477		'label'       => __( 'Help' ),478		'close_label' => __( 'Close' ),479		'icon'        => 'dashicons-editor-help',480		'class'       => '',481		'type'        => 'tooltip',482	);483 484	$args = wp_parse_args( $args, $defaults );485 486	$classes = ( 'tooltip' === $args['type'] ) ? 'wp-tooltip wp-is-tooltip' : 'wp-tooltip wp-is-toggletip';487	if ( '' !== $args['class'] ) {488		$classes .= ' ' . $args['class'];489	}490 491	$icon      = ( $args['icon'] ) ? trim( $args['icon'] ) : $defaults['icon'];492	$id        = ( $args['id'] ) ? $args['id'] : $defaults['id'];493	$button    = ( $args['button'] ) ? $args['button'] : $defaults['button'];494	$processed = false;495	$processor = new WP_HTML_Tag_Processor( $button );496	if ( true === $processor->next_tag( 'button' ) ) {497		$processor->add_class( 'wp-tooltip__toggle' );498		if ( 'tooltip' !== $args['type'] ) {499			$processor->set_attribute( 'popovertarget', '%2$s' );500			$processor->set_attribute( 'aria-haspopup', 'dialog' );501		}502		$button    = $processor->get_updated_html();503		$processed = true;504	} else {505		// Reset processor.506		$processor = new WP_HTML_Tag_Processor( $button );507		if ( true === $processor->next_tag( 'a' ) && 'tooltip' === $args['type'] ) {508			$processor->add_class( 'wp-tooltip__toggle' );509			$button    = $processor->get_updated_html();510			$processed = true;511		}512	}513	if ( ! $processed ) {514		// Button HTML passed was not valid.515		$processor = new WP_HTML_Tag_Processor( $defaults['button'] );516		$processor->add_class( 'wp-tooltip__toggle' );517		if ( 'tooltip' !== $args['type'] ) {518			$processor->set_attribute( 'popovertarget', '%2$s' );519			$processor->set_attribute( 'aria-haspopup', 'dialog' );520		}521		$button = $processor->get_updated_html();522	}523 524	/*525	 * The markup only uses phrasing content so it is valid when nested526	 * in a phrasing context. Sectioning content (e.g. `div`, `dialog`) will527	 * cause the parser to close an open `p`, creating an empty and breaking528	 * the layout. See #65660.529	 */530	if ( 'tooltip' === $args['type'] ) {531		// Tooltips are only used to visually display labels.532		$label  = wp_strip_all_tags( $content, true );533		$markup = sprintf(534			'<span class="%1$s">535				' . $button . '536				<span popover="hint" id="%2$s" class="wp-tooltip__bubble" role="tooltip">' .537					'<span id="%2$s-text" class="wp-tooltip__text">%5$s</span>' .538				'</span>' .539			'</span>',540			esc_attr( $classes ),541			esc_attr( $id ),542			esc_attr( $label ),543			esc_attr( $icon ),544			esc_html( $content ),545		);546	} else {

Changelog

Introduced in 7.1.0.

Signature, return type and hooks compared across 1 parsed release.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/general-template.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.