wp_add_inline_script() WordPress Function
The wp_add_inline_script() function allows you to add inline JavaScript to a registered script. This function should only be used if the inline code cannot be added using the wp_add_inline_style() function.
wp_add_inline_script( string $handle, string $data, string $position = 'after' ) #
Adds extra code to a registered script.
Description
Code will only be added if the script is already in the queue. Accepts a string $data containing the Code. If two or more code blocks are added to the same script $handle, they will be printed in the order they were added, i.e. the latter added code can redeclare the previous.
See also
Parameters
- $handle
(string)(Required)Name of the script to add the inline script to.
- $data
(string)(Required)String containing the JavaScript to be added.
- $position
(string)(Optional) Whether to add the inline script before the handle or after.
Default value: 'after'
Return
(bool) True on success, false on failure.
Source
File: wp-includes/functions.wp-scripts.php
function wp_add_inline_script( $handle, $data, $position = 'after' ) {
_wp_scripts_maybe_doing_it_wrong( __FUNCTION__, $handle );
if ( false !== stripos( $data, '</script>' ) ) {
_doing_it_wrong(
__FUNCTION__,
sprintf(
/* translators: 1: <script>, 2: wp_add_inline_script() */
__( 'Do not pass %1$s tags to %2$s.' ),
'<code><script></code>',
'<code>wp_add_inline_script()</code>'
),
'4.5.0'
);
$data = trim( preg_replace( '#<script[^>]*>(.*)</script>#is', '$1', $data ) );
}
return wp_scripts()->add_inline_script( $handle, $data, $position );
}
Expand full source codeCollapse full source codeView on TracView on GitHub
Changelog
| Version | Description |
|---|---|
| 4.5.0 | Introduced. |