wp_get_script_tag( array $attributes ): string
- Since
- 5.7.0
- Source
wp-includes/script-loader.php:2907
Description
It is possible to inject attributes in the <script> tag via the 'wp_script_attributes' filter.
Automatically injects type attribute if needed.
Compatibility
- WordPress
- since 5.7.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$attributesarray- Key-value pairs representing
<script>tag attributes.
Return value
string- String containing
<script>opening and closing tags.
Performance profile
How much work a call to wp_get_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
- Trivial
- Scaling
- Constant
- Instructions
- 15–28
- Plugin surface
- 1 hook
- Called by
- 2
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 28.
Third-party callbacks on 'wp_script_attributes' run inside this call, and their cost is not bounded by anything here.
2 places in core call this, so the cost is paid more often than your own code shows.
What it touches
- hookthird-party callbacks
apply_filters()called directly
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 · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_get_script_tag() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
isset($attributes) | 15 | apply_filters(), wp_sanitize_script_attributes() |
!isset($attributes) && is_admin() | 18 | is_admin(), apply_filters(), wp_sanitize_script_attributes() |
!isset($attributes) && !is_admin() && current_theme_supports() | 23 | is_admin(), current_theme_supports(), apply_filters(), wp_sanitize_script_attributes() |
!isset($attributes) && !is_admin() && !current_theme_supports() | 28 | is_admin(), current_theme_supports(), array_merge(), apply_filters(), wp_sanitize_script_attributes() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 28 | 15–28 | 3 | |
| 8.5 | 28 | 15–28 | 3 | |
| 8.4 | 28 | 15–28 | 3 | 1 fewer instruction than PHP 8.3 |
| 8.3 | 29 | 16–29 | 3 | |
| 8.2 | 29 | 16–29 | 3 | |
| 8.1 | 29 | 16–29 | 3 | |
| 7.4 | 29 | 16–29 | 3 |
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.
Hooks and filters fired · 1
One hook fires while wp_get_script_tag() runs, in this order:
- apply_filters( wp_script_attributes )filterline 2924 (+17 into the body)
Filters attributes to be added to a script tag.
Uses · 4
- is_admin()Determines whether the current request is for an administrative interface page.
- current_theme_supports()Checks a theme's support for a given feature.
- apply_filters()Calls the callback functions that have been added to a filter hook.
- wp_sanitize_script_attributes()Sanitizes an attributes array into an attributes string to be placed inside a `` tag.
Used by · 2
- WP_Scripts::do_item()Processes a script dependency.
- wp_print_script_tag()Prints formatted `` loader tag.
Source code
function wp_get_script_tag( $attributes ) { if ( ! isset( $attributes['type'] ) && ! is_admin() && ! current_theme_supports( 'html5', 'script' ) ) { // Keep the type attribute as the first for legacy reasons (it has always been this way in core). $attributes = array_merge( array( 'type' => 'text/javascript' ), $attributes ); } /** * Filters attributes to be added to a script tag. * * @since 5.7.0 * * @param array $attributes Key-value pairs representing `<script>` tag attributes. * Only the attribute name is added to the `<script>` tag for * entries with a boolean value, and that are true. */ $attributes = apply_filters( 'wp_script_attributes', $attributes ); return sprintf( "<script%s></script>\n", wp_sanitize_script_attributes( $attributes ) );}Changelog
Introduced in 5.7.0. One change between 6.7.7 and 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$attributes retyped from array to untyped.verified against sourceAbout this page
- Parsed data
- Generated from the wordpress-develop 6.9.7 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.