$pages->getPath() method

Given an ID, return a path to a page, without loading the actual page

  1. Always returns path in default language, unless a language argument/option is specified.
  2. Path may be different from 'url' as it doesn't include the root URL at the beginning.
  3. In most cases, it's preferable to use $page->path() rather than this method. This method is here just for cases where a path is needed without loading the page.
  4. It's possible for there to be Page::path() hooks, and this method completely bypasses them, which is another reason not to use it unless you know such hooks aren't applicable to you.

Available since version 3.0.6.

Example

// Get the path for page having ID 1234
$path = $pages->getPath(1234);
echo "Path for page 1234 is: $path";

Usage

// basic usage
$string = $pages->getPath($id);

// usage with all arguments
$string = $pages->getPath($id, $options = []);

Arguments

NameType(s)Description
idint, Page

ID of the page you want the path to

options (optional)null, array, Language, int, string

Specify $options array or Language object, id or name. Allowed options include:

  • language (int|string|anguage): To retrieve in non-default language, specify language object, ID or name (default=null)
  • useCache (bool): Allow pulling paths from already loaded pages? (default=true)
  • usePagePaths (bool): Allow pulling paths from PagePaths module, if installed? (default=true)

Return value

string

Path to page or blank on error/not-found.

See Also


$pages methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #514
    In the 514th issue of ProcessWire Weekly we'll check out the latest blog post from Ryan, introduce two new third party modules — Page List Versions Counter and Fieldtype Fieldset Panel — and more. Read on!
    Weekly.pw / 16 March 2024
  • Invoices Site Profile
    The new invoices site profile is a free invoicing application developed in ProcessWire. It enables you to create invoices, record payments to them, email invoices to clients, print invoices, and more. This post covers all the details.
    Blog / 15 March 2024
  • Subscribe to weekly ProcessWire news

“Yesterday I sent the client a short documentation for their ProcessWire-powered website. Today all features already used with no questions. #cmsdoneright—Marc Hinse, Web designer/developer