extractHash — GTM Variable Template for URL

VARIABLES › URL

extractHash CORE URL

Direct (.tpl) Apply (.tpl)

Extracts the fragment (hash) from a URL.

---

When to Use This

URL Processing

Parse, build, decode, and manipulate URLs and query parameters.

Extraction

Pull specific values, segments, or patterns from complex data structures.

---

Examples

Extract hash fragment

INPUT

URL: https://example.com/page#section1

OUTPUT

#section1

No hash returns undefined

INPUT

URL: https://example.com/page

OUTPUT

undefined

---

GTM Configuration

This is what you'll see when you open this variable in Google Tag Manager. Hover the icons for details.

Read-only Preview

extractHash

URL

💾 The URL to extract the hash from.

Supported formats:
  ✓ String

Input Setup

Input Function (optional)

⚙️ Optional pre-processing function applied to the input before internal logic (e.g., convert object to string, normalize case). Internal transformations such as case handling will still apply afterward.

Result Handling

Output Function (optional)

⚙️ Optional function to apply to the result before returning it (e.g., str => str + ' €', val => val !== undefined for boolean conversion). Useful for chaining transformations on the output.

---

Related Variables

Same category: URL

→ buildUrlFromParts → completeUrl → decodeUri → decodeUriComponent → encodeURIComponent → encodeUri → extractHashParams → extractHost → extractHostname → extractOrigin → extractPasword → extractPathname → extractPort → extractProtocol → extractSearch → extractSearchParams → extractSegmentByIndex → extractUserName → hasFragment → hasParameterWithValue → hasQueryString → parseUrlComponents → stringToPath

---

Under the Hood

📜 View Implementation Code

/**
 * Extracts the hash from a given URL.
 *
 * @param {string} data.src - The URL to extract the hash from.
 * @param {Function|string} [data.out] - Optional output handler: function to transform result or string with format.
 *
 * Direct-mode specific parameters:
 * @param {Function} [data.pre] - Optional pre-processor function to transform src before extracting.
 * 
 * @returns {string|undefined} The hash from the URL, or undefined if the input is invalid.
 *
 * @framework ggLowCodeGTMKit
 */

const parseUrl = require('parseUrl');

const extractHash = function(url) {
    const parsed = parseUrl(url);
    return parsed && parsed.hash || undefined;
};

const safeFunction = fn => typeof fn === 'function' ? fn : x => x;
const out = safeFunction(data.out);

// ===============================================================================
// extractHash - Direct mode
// ===============================================================================
const applyCast = (castFn, value) => safeFunction(castFn)(value);
const value = applyCast(data.pre, data.src);
return out(extractHash(value));

// ===============================================================================
// extractHash() – Apply Mode
// ===============================================================================
/*
return function(value) {
   return out(extractHash(value));
};
*/

🧪 View Test Scenarios (5 tests)

✅ '[example] Extract hash fragment'
✅ URL with hash and query string - should extract hash
✅ '[example] No hash returns undefined'
✅ URL with empty hash - should return undefined
✅ Invalid URL - should return undefined