Config

$config->paths and $config->urls

Two Paths objects that expose the server disk path and web URL for every named location in ProcessWire. All values end with a trailing slash.

// Server disk paths
$config->paths->root        // /var/www/html/
$config->paths->site        // /var/www/html/site/
$config->paths->templates   // /var/www/html/site/templates/
$config->paths->assets      // /var/www/html/site/assets/
$config->paths->files       // /var/www/html/site/assets/files/
$config->paths->cache       // /var/www/html/site/assets/cache/
$config->paths->logs        // /var/www/html/site/assets/logs/
$config->paths->modules     // /var/www/html/wire/modules/
$config->paths->siteModules // /var/www/html/site/modules/

// Web URLs (relative from domain root)
$config->urls->root        // / (or /subdir/ if PW is in a subdirectory)
$config->urls->site        // /site/
$config->urls->templates   // /site/templates/
$config->urls->assets      // /site/assets/
$config->urls->files       // /site/assets/files/
$config->urls->modules     // /wire/modules/
$config->urls->admin       // /processwire/ (or your custom admin URL)

// Full http/https absolute URLs (available on $config->urls only)
$config->urls->httpRoot         // https://domain.com/
$config->urls->httpAssets       // https://domain.com/site/assets/
$config->urls->httpFiles        // https://domain.com/site/assets/files/
$config->urls->httpTemplates    // https://domain.com/site/templates/

$config->url($for) and $config->path($for)

Get a single URL or disk path by name. Shorthand for $config->urls->get($for) and $config->paths->get($for).

$url  = $config->url('admin');      // "/processwire/"
$path = $config->path('templates'); // "/var/www/html/site/templates/"

$config->urls($for) and $config->paths($for)

Get a single value (like url() / path()) or, when called with no argument, return the whole Paths object.

$paths = $config->paths();         // Paths object (all paths)
$path  = $config->paths('files');  // "/var/www/html/site/assets/files/"
$path  = $config->paths->files;    // alias of above, better in IDEs

$config->setLocation($for, $dir, $url)

Update both the disk path and web URL for a named location.

• Arguments: setLocation(string $for, string $dir, string|bool $url = '')
• Returns: $this
• $for is any of: cache, logs, files, tmp, templates, or a custom name.
• Pass false for $url to update the path only (leaving URL unchanged).
• Paths relative to PW root should omit the leading slash.

// Redirect the templates path and URL to an alternate directory for one user
if($user->name === 'karen') {
    $config->setLocation('templates', 'site/dev-templates/');
}

$config->setPath($for, $path) and $config->setUrl($for, $url)

Update just the disk path or just the web URL for a named location.

$config->setPath('files', '/mnt/shared/files/'); // absolute path outside web root
$config->setUrl('files', 'https://cdn.example.com/');

Share PHP configuration values with client-side JavaScript. Values are exposed as ProcessWire.config[key].

$config->js($key, $value)

Share an existing $config property or set a new value for the JS side.

• Arguments: js(string|array|null $key = null, mixed $value = null)
• Returns: mixed|array|$this

// Set a value that is shared with JS
$config->js('myModule', [
    'baseUrl' => $config->urls->templates,
    'debug'   => $config->debug,
]);

// Share an existing $config property with JS (pass true as value)
$config->js('debug', true);        // exposes $config->debug to JS as-is
$config->js(['debug', 'version'], true); // share multiple properties at once

// Get a shared value from PHP
$val = $config->js('myModule');    // returns the array set above

// Get all shared values (returns array)
$all = $config->js();

$config->jsConfig($key, $value)

Like js(), but values are JS-only — they cannot be read back as $config->key. Preferred for new properties in ProcessWire 3.0.173+.

$config->jsConfig('mySettings', ['foo' => 'bar']);
$val = $config->jsConfig('mySettings'); // ['foo' => 'bar']
$all = $config->jsConfig();             // all JS-config-only values

$config->version($minVersion)

Check whether the current ProcessWire version meets a minimum. Pass no argument to get the version string.

if($config->version('3.0.200')) {
    // running PW 3.0.200 or newer
}
echo $config->version; // e.g. "3.0.258"

$config->phpVersion($minVersion)

Check whether the current PHP version meets a minimum.

if($config->phpVersion('8.1.0')) {
    // running PHP 8.1 or newer
}

$config->installedAfter($date) and $config->installedBefore($date)

Check the site installation timestamp. Useful in upgrade code that must run only for installations created after a particular date.

if($config->installedAfter('2024-01-01')) {
    // site was installed after 2024
}

These helpers are available before the API $input variable is ready, making them useful in /site/config.php and boot files.

$config->requestUrl($match, $get)

Get the current request URL (without query string). Pass a string or array of strings to test whether the URL contains any of them.

$url = $config->requestUrl();              // e.g. "/products/2024/"
if($config->requestUrl('/processwire/')) { // true if admin URL
    // ...
}
if($config->requestUrl(['foo', 'bar'])) {  // true if either string appears
    // ...
}
// Get query string only
$qs = $config->requestUrl('', 'query');   // e.g. "page=2&sort=title"

$config->requestPath($match)

Like requestUrl() but strips any subdirectory prefix, returning just the path relative to the PW installation root.

$path = $config->requestPath();           // e.g. "/products/2024/"
if($config->requestPath('/processwire/')) { ... }

$config->requestMethod($match)

Get or match the HTTP request method.

if($config->requestMethod('post')) { ... } // case-insensitive match
$method = $config->requestMethod();        // "GET", "POST", "PUT", etc.

Config properties that hold associative arrays can be read and updated using a method-call syntax. This lets you get or set individual keys without overwriting the whole array.

// Get one key from an array property
$siteOnly = $config->fileCompilerOptions('siteOnly');

// Set one key (other keys untouched)
$config->fileCompilerOptions('siteOnly', true);

// Set multiple keys at once
$config->fileCompilerOptions([
    'siteOnly'  => true,
    'cachePath' => $config->paths->root . '.my-cache/',
]);

// Unset a key (pass null as first argument, key name as second)
$config->fileCompilerOptions(null, 'siteOnly');

This works for any array-type config property: fileCompilerOptions, imageSizerOptions, webpOptions, wireMail, contentTypes, fileContentTypes, dbOptions, pageList, pageEdit, AdminThemeUikit, and others.

• $config extends WireData, so any value not defined in wire/config.php or site/config.php will simply return null.
• You can define your own site-specific settings in /site/config.php and read them from $config anywhere in your templates.
• Changes to $config at runtime (e.g. in /site/ready.php) affect all subsequent code in the same request only — they are not persisted.
• The canonical reference for all configurable settings, their defaults, and inline documentation is /wire/config.php.
• Source files: wire/core/Config/Config.php, wire/core/Config/Paths.php, wire/core/Config/FilenameArray.php.