$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.168

Twitter updates

  • Happy New Year! Today I’ve bumped the version on the dev branch to 3.0.170, and it’s quite a lot of updates. This post covers most of them. In this post, there’s also a question for you: what would you like to see in ProcessWire in 2021? More
    1 January 2021
  • In this week’s blog post we’ll take a brief look at a powerful new ProFields module for ProcessWire that’s just around the corner—the Combo field: More
    4 December 2020
  • There’s a new modules directory on the ProcessWire site now up and running. In this post we’ll cover a few details about what’s changed and what’s new—More
    20 November 2020

Latest news

  • ProcessWire Weekly #346
    This week in the 346th issue of ProcessWire Weekly we're going to cover the latest weekly update from Ryan, post a new poll, and introduce a brand new site of the week. Read on!
    Weekly.pw / 26 December 2020
  • ProcessWire 3.0.170 core updates
    Happy New Year! Today I’ve bumped the version on the dev branch to 3.0.170, and it’s quite a lot of updates. This post covers most of them. In this post, there’s also a question for you: what would you like to see in ProcessWire in 2021?
    Blog / 1 January 2021
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits