PageBuilderUtmUrl snippet

Appends UTM parameters from the CMP registry to any URL. The link gets the current visit tags. You do not build the query string in the template. Values come from the query string, $_SESSION['utm'], or the record default_value in pb_utm_params.

Where to call

Template, chunk outside PageBuilder, custom buttons. For url/button fields inside sections, use {{utm:key}} in the inspector instead.

Parameters

Parameter	Default	Description
url	empty	Target URL. Empty → empty output
params	empty	JSON with extra query params. Keys in params override the registry

Basic call

modx

[[!PageBuilderUtmUrl?
  &url=`https://example.com/landing`
]]

fenom

{'!PageBuilderUtmUrl' | snippet : [
  'url' => 'https://example.com/landing'
]}

Extra query parameters

modx

[[!PageBuilderUtmUrl?
  &url=`/contacts/`
  &params=`{"utm_content":"hero-cta"}`
]]

fenom

{'!PageBuilderUtmUrl' | snippet : [
  'url' => '/contacts/',
  'params' => '{"utm_content":"hero-cta"}'
]}

Fenom: utm_query modifier

The PageBuilder plugin registers the modifier on pdoToolsOnFenomInit:

<a href="{$button.url|utm_query}">{$button.label}</a>

The second modifier argument is an array of extra query parameters. Those keys override the registry, like &params= on the snippet:

<a href="{$button.url|utm_query:['utm_content' => 'hero-cta']}">{$button.label}</a>

For a URL from section data this is the same as calling the snippet.

UTM session

For first-visit tags in links, call PageBuilderUtmSession before render or rely on the PageBuilder plugin.

See also

• PageBuilderUtmSession
• CMP → UTM