URL operators #

This page is for designers who write links. Never write /news/article or /extension/mytheme/... by hand: the site may run under a path prefix, a siteaccess in the URL or a different host. The URL operators of kernel/common/ezurloperator.php build correct URLs.

Contents #

1. The operators
2. Quotes
3. Full URLs
4. Examples
5. ezsys and exturl

The operators #

Quotes #

By default the operators return the URL with double quotes, so you write the attribute without quotes:

<a href={$node.url_alias|ezurl}>...</a>

The first parameter changes that: 'single' for single quotes, 'no' for none:

<a href="{$node.url_alias|ezurl( 'no' )}#comments">...</a>
srcset="{$img.url|ezroot( 'no' )} 480w"

With 'no' you are responsible for the quotes around the attribute.

Full URLs #

The second parameter 'full' adds the scheme and host (from eZSys::serverURL()), for canonical links, Open Graph tags and mails:

<link rel="canonical" href={$node.url_alias|ezurl( 'double', 'full' )}>
<meta property="og:url" content={$node.url_alias|ezurl( 'double', 'full' )}>

Examples #

<a href={'/'|ezurl}>{'Home'|i18n( 'design/mytheme' )}</a>
<a href={'/user/login'|ezurl}>{'Sign in'|i18n( 'design/mytheme' )}</a>
<form action={'/content/search'|ezurl} method="get">...</form>
<img src={'logo.svg'|ezimage} alt="{$site.title|wash}">
<img src={$node.data_map.image.content['medium'].url|ezroot} alt="...">
<link rel="manifest" href={'images/favicon/site.webmanifest'|ezdesign}>

A link to a node: $node.url_alias|ezurl. A link to a view with parameters: concat( $node.url_alias, '/(offset)/', $offset )|ezurl.

ezsys and exturl #

• ezsys( 'wwwdir' ), ezsys( 'indexdir' ), ezsys( 'indexfile' ), ezsys( 'sitedir' ), ezsys( 'querystring' ) return facts about the installation and request (the attributes eZSys::attributes() lists). Another name is a template warning.
• exturl registers an external URL in the kernel's URL table (the list of links the administration can check) and returns it. For an ordinary external link, write the URL directly (href="https://...") and wash it if it comes from content.

Related pages #

• Images in a design
• Wash and escaping
• Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.