wp_get_inline_script_tag( string $data, $attributes = array() ): string

Description

// The dangerous JavaScript in this example will be safely escaped.
// A string with the script tag and the desired contents will be returned.
wp_get_inline_script_tag( 'console.log( "</script>" );' );

// This data is unsafe and text/plain cannot be escaped.
// The following will return "" to indicate failure:
wp_get_inline_script_tag( '</script>', array( 'type' => 'text/plain' ) );

Compatibility

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

Parameters

$datastring

Data for script tag: JavaScript, importmap, speculationrules, etc.

$attributesoptional

Default: array()

Return value

string

HTML script tag containing the provided $data or the empty string "" if the data cannot be safely embedded in a script tag.

Performance profile

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

Light

Touches nothing outside its own arguments.

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

25–29

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

Plugin surface

1 hook

Third-party callbacks on 'wp_inline_script_attributes' run inside this call, and their cost is not bounded by anything here.

Called by

8

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

What it touches

• hookthird-party callbacksapply_filters()called directly

What one call costs · 2 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while wp_get_inline_script_tag() runs, in this order:

1. 1
   apply_filters( wp_inline_script_attributes )filterline 3034 (+13 into the body)

   Filters attributes to be added to a script tag.

Uses · 2

• apply_filters()Calls the callback functions that have been added to a filter hook.
• WP_HTML_Tag_Processor::__construct()Constructor.

Used by · 8

• WP_Customize_Manager::wp_die()Custom wp_die wrapper. Returns either the standard message for UI or the Ajax message.
• WP_Scripts::do_item()Processes a script dependency.
• WP_Scripts::get_inline_script_tag()Gets tags for inline scripts registered for a specific handle.
• block_core_archives_build_dropdown_script()Generates the inline script for an archives dropdown field.
• build_dropdown_script_block_core_categories()Generates the inline script for a categories dropdown field.
• get_post_embed_html()Retrieves the embed code for a specific post.
• wp_admin_bar_command_palette_menu()Adds the command palette trigger button.
• wp_print_inline_script_tag()Prints an inline script tag.

Source code

View on Trac ↗View on GitHub ↗

3021function wp_get_inline_script_tag( $data, $attributes = array() ) {3022	$data = "\n" . trim( $data, "\n\r " ) . "\n";3023 3024	/**3025	 * Filters attributes to be added to a script tag.3026	 *3027	 * @since 5.7.03028	 *3029	 * @param array<string, string|bool> $attributes Key-value pairs representing `<script>` tag attributes.3030	 *                                               Only the attribute name is added to the `<script>` tag for3031	 *                                               entries with a boolean value, and that are true.3032	 * @param string                     $data       Inline data.3033	 */3034	$attributes = apply_filters( 'wp_inline_script_attributes', $attributes, $data );3035 3036	$processor = new WP_HTML_Tag_Processor( '<script></script>' );3037	$processor->next_tag();3038	foreach ( $attributes as $name => $value ) {3039		/*3040		 * Lexical variations of an attribute name may represent the3041		 * same attribute in HTML, therefore it’s possible that the3042		 * input array might contain duplicate attributes even though3043		 * it’s keyed on their name. Calling code should rewrite an3044		 * attribute’s value rather than sending a duplicate attribute.3045		 *3046		 * Example:3047		 *3048		 *     array( 'id' => 'main', 'ID' => 'nav' )3049		 *3050		 * In this example, there are two keys both describing the `id`3051		 * attribute. PHP array iteration is in key-insertion order so3052		 * the 'id' value will be set in the SCRIPT tag.3053		 */3054		if ( null !== $processor->get_attribute( $name ) ) {3055			continue;3056		}3057 3058		$processor->set_attribute( $name, $value ?? true );3059	}3060 3061	if ( ! $processor->set_modifiable_text( $data ) ) {3062		return '';3063	}3064 3065	return "{$processor->get_updated_html()}\n";3066}

Changelog

Introduced in 5.7.0. One change between 6.7.7 and 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 7.1.0 tag, from src/wp-includes/script-loader.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.