Skip to Content
Menu

sanitizeClassName()

Further sanitize a string to be safe to use in HTML classes and other attributes.

JavaScript April 27, 2025

Usage

JavaScript
nebula.sanitizeClassName(text)

Parameters

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

Request or provide clarification »

Examples

Sanitize a text string

JavaScript
let safeFontName = nebula.sanitizeClassName(fontName);
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 901.

    No Hooks

    This function does not have any filters or actions available. Request one?
    JavaScript
    nebula.sanitizeClassName = function(text){
        let cleanText = nebula.sanitize(text).trim(); //Sanitize the text first
    
        if ( /['"`]/.test(cleanText) ){ //This is an attempt to speed this up to avoid the RegEx happening when it does not need to
            cleanText = cleanText.replace(/\"|\'|\`/ig, ""); //Remove quotes and apostrophes
        }
    
        cleanText = cleanText.toLowerCase().replaceAll(/(\(.*\))|\W/ig, ''); //Any non-word characters \W or anything inside of parenthesis (including the parenthesis) removed
    
        return cleanText;
    };
    

    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.sanitizeClassName = 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.sanitizeClassName = 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.sanitizeClassName === 'function' ){
            nebula.sanitizeClassName = function(text){
                //Write your own code here, leave it blank, or return false.
            }
    	}
    });