Skip to Content
Menu

readCookie()

Get data from a cookie.

JavaScript February 7, 2021

Usage

JavaScript
nebula.readCookie(name)

Parameters

name
(Required) (String) The name of the cookie
Default: None

Request or provide clarification »

Demo


Toggle cookie: OFF Last set on: (not set)


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 541.

    No Hooks

    This function does not have any filters or actions available. Request one?
    JavaScript
    nebula.readCookie = function(name){
        let nameEQ = name + '=';
        let cookies = document.cookie.split(';');
    
        for ( let cookie of cookies ){
            while ( cookie.charAt(0) === ' ' ){
                cookie = cookie.substring(1, cookie.length);
            }
    
            if ( cookie.indexOf(nameEQ) === 0 ){
                return cookie.substring(nameEQ.length, cookie.length);
            }
        }
    
        return null;
    };
    

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


    For dynamically imported module function overrides:

    jQuery(window).on('load', function(){
        nebula.readCookie = function(name){
            //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.readCookie === 'function' ){
            nebula.readCookie = function(name){
                //Write your own code here, leave it blank, or return false.
            }
    	}
    });