Template::urlSegments() method

Get or set allowed URL segments

Usage

// basic usage
$array = $template->urlSegments();

// usage with all arguments
$array = $template->urlSegments($value = '~');

Arguments

NameType(s)Description
value (optional)array, int, bool, string

Omit to return current value, or to set value:

  • Specify array of allowed URL segments, may include 'segment', 'segment/path' or 'regex:your-regex'.
  • Or specify boolean true or 1 to enable all URL segments.
  • Or specify integer 0, boolean false, or blank array to disable all URL segments.

Return value

array int

Returns array of allowed URL segments, or 0 if disabled, or 1 if any allowed.


Template methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #550
    In the 550th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module called PagefileMetadata, and more. Read on!
    Weekly.pw / 23 November 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

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer