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>&lt;script&gt;</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 );
}

Uses

Uses Description
wp-includes/class-pop3.php: stripos()
wp-includes/class.wp-scripts.php: WP_Scripts::add_inline_script()

Adds extra code to a registered script.
wp-includes/functions.wp-scripts.php: wp_scripts()

Initialize $wp_scripts if it has not been set.
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/functions.php: _doing_it_wrong()

Mark something as being incorrectly called.

Used By

Used By Description
wp-includes/block-editor.php: block_editor_rest_api_preload()

Preloads common data used with the block editor by specifying an array of REST API paths that will be preloaded for a given block editor context.
wp-includes/script-loader.php: enqueue_editor_block_styles_assets()

Function responsible for enqueuing the assets required for block styles functionality on the editor.
wp-admin/includes/post.php: the_block_editor_meta_boxes()

Renders the meta boxes forms.
wp-admin/includes/class-wp-privacy-policy-content.php: WP_Privacy_Policy_Content::notice()

Add a notice with a link to the guide when editing the privacy policy page.
wp-includes/general-template.php: wp_enqueue_code_editor()

Enqueue assets needed by the code editor for the given settings.
wp-includes/widgets/class-wp-widget-text.php: WP_Widget_Text::_register_one()

Add hooks for enqueueing assets when registering all widget instances of this widget class.
wp-includes/widgets/class-wp-widget-media-gallery.php: WP_Widget_Media_Gallery::enqueue_admin_scripts()

Loads the required media files for the media manager and scripts for media widgets.
wp-includes/widgets/class-wp-widget-custom-html.php: WP_Widget_Custom_HTML::_register_one()

Add hooks for enqueueing assets when registering all widget instances of this widget class.
wp-includes/widgets/class-wp-widget-custom-html.php: WP_Widget_Custom_HTML::enqueue_admin_scripts()

Loads the required scripts and styles for the widget control.
wp-includes/widgets/class-wp-widget-text.php: WP_Widget_Text::enqueue_admin_scripts()

Loads the required scripts and styles for the widget control.
wp-includes/widgets/class-wp-widget-media-audio.php: WP_Widget_Media_Audio::enqueue_admin_scripts()

Loads the required media files for the media manager and scripts for media widgets.
wp-includes/widgets/class-wp-widget-media-video.php: WP_Widget_Media_Video::enqueue_admin_scripts()

Loads the required scripts and styles for the widget control.
wp-includes/widgets/class-wp-widget-media-image.php: WP_Widget_Media_Image::enqueue_admin_scripts()

Loads the required media files for the media manager and scripts for media widgets.
wp-includes/script-loader.php: wp_localize_jquery_ui_datepicker()

Localizes the jQuery UI datepicker.
wp-includes/class-wp-customize-widgets.php: WP_Customize_Widgets::enqueue_scripts()

Enqueues scripts and styles for Customizer panel and export data to JavaScript.

Changelog

Version Description
4.5.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/wp_add_inline_script