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

Description

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

string

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

Uses · 1

• wp_get_tooltip_helper()Retrieves the markup for an accessible tooltip or toggletip.

Source

View on Trac ↗View on GitHub ↗

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

History

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.