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: empty string

  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

113–176

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

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 · 144 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.

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

• 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'      => '',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 494	// Tooltips use the content as the accessible name; toggletips use the label.495	$label = ( 'tooltip' === $args['type'] ) ? wp_strip_all_tags( $content, true ) : $args['label'];496 497	/*498	 * The generated button is a plain skeleton. Every dynamic attribute is499	 * added through the tag processor below, so caller-supplied markup is500	 * never scanned or substituted and a percent sign in custom markup,501	 * such as a percent-encoded URL, is never treated as a conversion502	 * specification.503	 */504	$default_button = '<button type="button"><span></span></button>';505 506	$is_default = ! $args['button'];507	$button     = ( $args['button'] ) ? $args['button'] : $default_button;508 509	// The accepted root element is a `button`, or an `a` for tooltips.510	$tag       = false;511	$processor = new WP_HTML_Tag_Processor( $button );512	if ( true === $processor->next_tag( 'button' ) ) {513		$tag = 'button';514	} else {515		$processor = new WP_HTML_Tag_Processor( $button );516		if ( 'tooltip' === $args['type'] && true === $processor->next_tag( 'a' ) ) {517			$tag = 'a';518		}519	}520 521	if ( false === $tag ) {522		// Button HTML passed was not valid. Reset to default.523		$is_default = true;524		$button     = $default_button;525		$processor  = new WP_HTML_Tag_Processor( $button );526		$processor->next_tag( 'button' );527		$tag = 'button';528	}529 530	/*531	 * Attributes that apply to every accepted button are added in one pass.532	 * Attributes that name the control are only added when the caller's533	 * markup did not already provide them.534	 */535	if ( null === $processor->get_attribute( 'aria-label' ) ) {536		$processor->set_attribute( 'aria-label', $label );537	}538	$processor->add_class( 'wp-tooltip__toggle' );539	if ( 'button' === $tag && 'tooltip' !== $args['type'] ) {540		$processor->set_attribute( 'popovertarget', $id );541		$processor->set_attribute( 'aria-haspopup', 'dialog' );542	}543 544	// The generated button also carries the dashicon on its inner span.545	if ( $is_default && true === $processor->next_tag( 'span' ) ) {546		$processor->set_attribute( 'class', 'dashicons ' . $icon );

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.3 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.