wppaste
WordPress

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

Since
7.1.0
Source
wp-includes/general-template.php:430
Retrieves the markup for an accessible toggle tip.

Description

Returns a button and an action triggered toggle tip with $content.

Compatibility

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

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

Return value

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

Performance profile

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

Executed per call on PHP 8.5. The body compiles to 9.

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 one call costs · 1 distinct outcome

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

WhenInstructionsCalls it makes
always9wp_get_tooltip_helper()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 9 instructions, 9 executed per call, 0 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 · 1

Source code

View on Trac View on GitHub 

function wp_get_toggletip( $content, $args = array() ) {	$args['type'] = 'toggletip';	return wp_get_tooltip_helper( $content, $args );}

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.