PagesLoader::getByPath()

Get a page by its path, similar to $pages->get('/path/to/page/') but with more options

Please note

  1. There are no exclusions for page status or access. If needed, you should validate access on any page returned from this method.
  2. In a multi-language environment, you must specify the $useLanguages option to be true, if you want a result for a $path that is (or might be) a multi-language path. Otherwise, multi-language paths will make this method return a NullPage (or 0 if getID option is true).
  3. Partial paths may also match, so long as the partial path is completely unique in the site. If you don't want that behavior, double check the path of the returned page.
  4. See also the newer/more capable $pages->pathFinder() methods get('/path/') and getPage('/path/').

Usage

// basic usage
$page = $pagesLoader->getByPath(string $path);

// usage with all arguments
$page = $pagesLoader->getByPath(string $path, $options = []);

Arguments

NameType(s)Description
$pathstring
$options (optional)array bool

array of options (below), or specify boolean for $useLanguages option only.

  • getID (bool): Specify true to just return the page ID Default:false
  • useLanguages (bool): Specify true to allow retrieval by language-specific paths Default:false
  • useHistory (bool): Allow use of previous paths used by the page, if PagePathHistory module is installed Default:false
  • allowUrl (bool): Allow getting page by path OR url? Specify false to find only by path. This option only applies if the site happens to run from a subdirectory. Default:true 3.0.184+
  • allowPartial (bool): Allow partial paths to match? Default:true 3.0.184+
  • allowUrlSegments (bool): Allow paths with URL segments to match? When true and page match cannot be found, the closest parent page that allows URL segments will be returned. Found URL segments are populated to a _urlSegments array property on the returned page object. This also cancels the allowPartial setting. Default:false 3.0.184+

Return value

Page int

See Also

PagesLoader methods and properties

API reference based on ProcessWire core version 3.0.251