WordPress at a glance

esc_js() WP 1.0

Escape single quotes, htmlspecialchar " < > &, and fix line endings.

Escapes text strings for echoing in JS. It is intended to be used for inline JS (in a tag attribute, for example onclick="..."). Note that the strings have to be in single quotes. The 'js_escape' filter is also applied here.

Works based on: _wp_specialchars()

No Hooks.


String. Escaped text.


esc_js( $text );
$text(string) (required)
The text to be escaped.

Code of esc_js: wp-includes/formatting.php VER 5.0

function esc_js( $text ) {
	$safe_text = wp_check_invalid_utf8( $text );
	$safe_text = _wp_specialchars( $safe_text, ENT_COMPAT );
	$safe_text = preg_replace( '/&#(x)?0*(?(1)27|39);?/i', "'", stripslashes( $safe_text ) );
	$safe_text = str_replace( "\r", '', $safe_text );
	$safe_text = str_replace( "\n", '\\n', addslashes( $safe_text ) );
	 * Filters a string cleaned and escaped for output in JavaScript.
	 * Text passed to esc_js() is stripped of invalid or special characters,
	 * and properly slashed for output.
	 * @since 2.0.6
	 * @param string $safe_text The text after it has been escaped.
 	 * @param string $text      The text prior to being escaped.
	return apply_filters( 'js_escape', $safe_text, $text );

Related Functions

From tag: esc_ (clean validate sanitize)

More from category: Sanitizing, Escaping

No comments
    Hello, !     Log In . Register