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 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 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 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
API reference based on ProcessWire core version 3.0.236