Skip to Content
Menu

sanitize()

Simply sanitize text to prevent basic XSS.

JavaScript February 7, 2021

Usage

JavaScript
sanitize(text)

Parameters

text
(Required) (String) The text to sanitize
Default: None

Request or provide clarification »

Examples

JavaScript
jQuery('input').on('keyup', function(){
    //Do a filter here (for example)
    jQuery('.status').html('Showing results for ' + nebula.sanitize(jQuery(this).val()));
});
Was this page helpful? Yes No


    A feedback message is required to submit this form.


    Please check that you have entered a valid email address.

    Enter your email address if you would like a response.

    Thank you for your feedback!

    Source File

    Located in /assets/js/modules/utilities.js on line 829.

    No Hooks

    This function does not have any filters or actions available. Request one?
    JavaScript
    nebula.sanitize = function(text){
        return document.createElement('div').appendChild(document.createTextNode(text)).parentNode.innerHTML; //Raw JS is more efficient than jQuery for this
    };
    

    Override

    To override or disable this JavaScript function, simply redeclare it with the exact same function name. Remember: Some functionality is conditionally loaded via dynamic imports, so if your function is not overriding properly, try listening for a DOM event (described below).

    JavaScript

    For non-module import functions:

    nebula.sanitize = function(text){
        //Write your own code here, leave it blank, or return false.
    }


    For dynamically imported module function overrides:

    jQuery(window).on('load', function(){
        nebula.sanitize = function(text){
            //Write your own code here, leave it blank, or return false.
        }
    });


    Custom Nebula DOM events do also exist, so you could also try the following if the Window Load listener does not work:

    jQuery(document).on('nebula_module_loaded', function(module){
        //Note that the module variable is also available to know which module specifically was imported
        if ( typeof nebula.sanitize === 'function' ){
            nebula.sanitize = function(text){
                //Write your own code here, leave it blank, or return false.
            }
    	}
    });