whereMatch()

Signature

whereMatch() — returns struct

Available in: mapper Category: Routing

Description

Constrain a route variable with a custom regex pattern.

Parameters

Name	Type	Required	Default	Description
variableName	string	yes	—	The route variable name to constrain.
pattern	string	yes	—	The regex pattern the variable must match.

Examples

<cfscript>

mapper()
    // 1. Constrain a route variable to a custom regex pattern (year: 4-digit number)
    .get(name="archiveYear", pattern="archive/[year]", to="posts##archiveByYear")
    .whereMatch(variableName="year", pattern="\d{4}")

    // 2. Constrain a slug variable to lowercase letters and hyphens only
    .get(name="articleShow", pattern="articles/[slug]", to="articles##show")
    .whereMatch(variableName="slug", pattern="[a-z][a-z0-9-]+")

    // 3. Chained with resources — constrain the key to a specific format (e.g. SKU like AB-12345)
    .resources("products")
    .whereMatch(variableName="key", pattern="[A-Z]{2}-\d{5}")
.end();

</cfscript>