esc_js( string $text )
Escape single quotes, htmlspecialchar ” &, and fix line endings.
Contents
Description Description
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.
Parameters Parameters
- $text
-
(string) (Required) The text to be escaped.
Return Return
(string) Escaped text.
Source Source
File: wp-includes/formatting.php
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 );
}
Expand full source code Collapse full source code View on Trac
Changelog Changelog
| Version | Description |
|---|---|
| 2.8.0 | Introduced. |
More Information More Information
See Data Validation for more information on escaping and sanitization.
User Contributed Notes User Contributed Notes
You must log in before being able to contribute a note or feedback.
I don’t really see the value of using
esc_js()anymore. If you really have to do an inline script attribute, you may want to consider the following example withwp_json_encode()andesc_attr(), which seems easier to read and maintain:<?php $onfocus = sprintf( 'if ( %s === this.value ) { this.value = ""; }', wp_json_encode( $instance['input_text'] ) ); $onblur = sprintf( 'if ( "" === this.value ) { this.value = %s; }', wp_json_encode( $instance['input_text'] ) ); ?> <input id="subbox" type="text" name="email" value="<?php echo esc_attr( $instance['input_text'] ); ?>" onfocus="<?php echo esc_attr( $onfocus ); ?>" onblur="<?php echo esc_attr( $onblur ); ?>" />Expand full source codeCollapse full source code
But in actuality, this specific example doesn’t need any PHP in its script attributes at all. The following should have the same result, thanks to the
defaultValueproperty on theHTMLInputElementinterface:<input id="subbox" type="text" name="email" value="<?php echo esc_attr( $instance['input_text'] ); ?>" onfocus="if ( this.defaultValue === this.value ) { this.value = ''; }" onblur="if ( '' === this.value ) { this.value = this.defaultValue; }" />Feedback
But for the sake of filters, you should use
esc_js()where javascript is using the value. You see when you useesc_attr(), the output is filtered withattribute_escape. But foresc_js(), output is filtered withjs_escapehook. So other plugins can know it’s being escaped for js usage. — By Sohan Zaman —Example
Example of an input tag within a form displayed on the front-end of the site, generated from a widget. The first php segment is using esc_attr as it is an html attribute of input, while the next php segments is using esc_js within inline JavasSript.
<input type="text" value="<?php echo esc_attr( $instance['input_text'] ); ?>" id="subbox" onfocus="if ( this.value == '<?php echo esc_js( $instance['input_text'] ); ?>') { this.value = ''; }" onblur="if ( this.value == '' ) { this.value = '<?php echo esc_js( $instance['input_text'] ); ?>'; }" name="email" />If you’re not working with inline JS in HTML event handler attributes, a more suitable function to use is wp_json_encode(), which is built-in to WordPress. (wp_json_encode() includes the string-delimiting quotes for you):