$pages->getPath() method

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

Always returns path in default language, unless a language argument/option is specified.
Path may be different from 'url' as it doesn't include the root URL at the beginning.
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.
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.

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

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

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

Name Type(s) Description

Name	Type(s)	Description
`id`	int, 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)

id

int, 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)

string

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