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 in 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
-
(Required) Name of the script to add the inline script to.
- $data
-
(Required) String containing the javascript to be added.
- $position
-
(Optional) Whether to add the inline script before the handle or after. Default '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__ );
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>'
), 'WP-4.5.0' );
$data = trim( preg_replace( '#<script[^>]*>(.*)</script>#is', '$1', $data ) );
}
return wp_scripts()->add_inline_script( $handle, $data, $position );
}
Changelog
| Version | Description |
|---|---|
| WP-4.5.0 | Introduced. |