$config->setUrl() method

Change or set just the URL for the named location (leaving server disk path as-is)

  • If you want to update both disk path and URL at the same time, or if URL and path are going to be the same relative to installation root, use the setLocation() method instead.

  • Paths relative to PW installation root should omit the leading slash, i.e. use site/templates/ and NOT /site/templates/.

  • The $for argument can be: cache, logs, files, tmp, templates, or one of your own. Other named locations may also work, but since they can potentially be used before PW’s “ready” state, they may not be reliable.

  • Warning: anything that changes a system URL may make the URL no longer have the protection of the root .htaccess file. As a result, if you modify system URLs for anything on a live server, you should also update your .htaccess file to reflect your changes (while leaving existing rules for original URL in place).

The following examples would go in /site/ready.php.

Let’s say we created a symbolic link in our web root /tiedostot/ (Finnish for “files”) that points to /site/assets/files/. We want all of our file URLs to appear as “/tiedostot/1234/img.jpg” rather than “/site/assets/files/1234/img.jpg”. We would change the URL for ProcessWire’s $config->urls->files to point there like this example below. (Please also see warning above)

In this next example, we are changing all of our file URLs on the front-end to point a cookieless subdomain that maps all requests to the root path of https://files.domain.com to /site/assets/files/. The example works for CDNs as well.

Available since version 3.0.141.

Examples

if($page->template != 'admin') {
  $config->setUrl('files', 'tiedostot/');
}
if($page->template != 'admin) {
  $config->setUrl('files', 'https://files.domain.com/');
}

Usage

$self = $config->setUrl(string $for, string $url);

Arguments

NameType(s)Description
forstring

Named location from $config->urls, one of: cache, logs, files, tmp, templates, or your own.

urlstring

URL relative to PW installation root (no leading slash) or absolute URL if not (optionally including scheme and domain).

Return value

self

Exceptions

Method can throw exceptions on error:

  • WireException


$config methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #544
    In the 150th issue of ProcessWire Weekly we'll check out brand-new third party module called Inputfield Dependency Helper, share some recent highlights from the support forum, and more. Read on!
    Weekly.pw / 12 October 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“We were really happy to build our new portfolio website on ProcessWire! We wanted something that gave us plenty of control on the back-end, without any bloat on the front end - just a nice, easy to access API for all our content that left us free to design and build however we liked.” —Castus, web design agency in Sheffield, UK