Documentation

function.crmURL.php

Tags
copyright

CiviCRM LLC

Table of Contents

Functions

smarty_function_crmURL()  : string
Generate a URL.

Functions

smarty_function_crmURL()

Generate a URL.

smarty_function_crmURL(array<string|int, mixed> $params) : string

Ex: {crmURL p='civicrm/acl/entityrole' q='reset=1'} Ex: {crmURL p='civicrm/profile/create' q='id=123&reset=1' fe=1}

Each URL component uses an abbreviation (e.g. "p"<=>"path"; "q"<=>"query").

Parameters
$params : array<string|int, mixed>

List of URL properties.

  • "p" (string $path) The path being linked to, such as "civicrm/add".
  • "q" (array|string $query) A query string to append to the link, or an array of key-value pairs.
  • "a" (bool $absolute) Whether to force the output to be an absolute link (beginning with a URI-scheme such as 'http:'). Useful for links that will be displayed outside the site, such as in an RSS feed.
  • "f" (string $fragment) A "#" fragment to append to the link. This could a named anchor (as in #section2) or a client-side route (as in #/mailing/new).
  • "h" (bool $htmlize) Whether to encode special html characters such as &.
  • "fe" (bool $frontend) This link should be to the CMS front end (applies to WP & Joomla).
  • "fb" (bool $forceBackend) This link should be to the CMS back end (applies to WP & Joomla).
Return values
string

        
On this page

Search results