$page->path() method

Returns the Page’s path from the ProcessWire installation root.

The path is always indicated from the ProcessWire installation root. Meaning, if the installation is running from a subdirectory, then the path does not include that subdirectory, whereas the url does. Note that path and url are identical if installation is not running from a subdirectory.

Example

// Difference between path and url on site running from subdirectory /my-site/
echo $page->path(); // outputs: /about/contact/
echo $page->url();  // outputs: /my-site/about/contact/

Usage

$string = $page->path();

Return value

string

Returns the page path, for example: /about/contact/


Hooking $page->path()

You can add your own hook events that are executed either before or after the $page->path() method is executed. Examples of both are included below. A good place for hook code such as this is in your /site/ready.php file.

Hooking before

The 'before' hooks are called immediately before each $page->path() method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

$this->addHookBefore('Page::path', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $page = $event->object;

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
});

Hooking after

The 'after' hooks are called immediately after each $page->path() method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('Page::path', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $page = $event->object;

  // An 'after' hook can retrieve and/or modify the return value
  $return = $event->return;

  /* Your code here, perhaps modifying the return value */

  // Populate back return value, if you have modified it
  $event->return = $return;
});

See Also


$page methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #524
    In the 524th issue of ProcessWire Weekly we'll check out what's new in the core this week, introduce a new module called SEO Text Width, and more. Read on!
    Weekly.pw / 25 May 2024
  • ProFields Table Field with Actions support
    This week we have some updates for the ProFields table field (FieldtypeTable). These updates are primarily focused on adding new tools for the editor to facilitate input and management of content in a table field.
    Blog / 12 April 2024
  • Subscribe to weekly ProcessWire news

“I am currently managing a ProcessWire site with 2 million+ pages. It’s admirably fast, and much, much faster than any other CMS we tested.” —Nickie, Web developer