$pages->touch() method

Update page modification time to now (or the given modification time)

This behaves essentially the same as the unix touch command, but for ProcessWire pages.

Available since version 3.0.0.

Example

// Touch the current $page to current date/time
$pages->touch($page);

// Touch the current $page and set modification date to 2016/10/24
$pages->touch($page, "2016-10-24 00:00");

// Touch all "skyscraper" pages in "Atlanta" to current date/time
$skyscrapers = $pages->find("template=skyscraper, parent=/cities/atlanta/");
$pages->touch($skyscrapers); 

Usage

// basic usage
$bool = $pages->touch($pages);

// usage with all arguments
$bool = $pages->touch($pages, $modified = null);

Arguments

NameType(s)Description
pagesPage, PageArray, array

May be Page, PageArray or array of page IDs (integers).

modified (optional)null, int, string

Omit to update to now, or specify unix timestamp or strtotime() recognized time string

Return value

bool

True on success, false on fail

Exceptions

Method can throw exceptions on error:

  • WireException - if given invalid format for $modified argument or failed database query


Hooking $pages->touch(…)

You can add your own hook events that are executed either before or after the $pages->touch(…) 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 $pages->touch(…) method call is executed. This type of hook is especially useful for modifying arguments before they are sent to the method.

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

  // Get values of arguments sent to hook (and optionally modify them)
  $pages = $event->arguments(0);
  $modified = $event->arguments(1);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $pages);
  $event->arguments(1, $modified);
});

Hooking after

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

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

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

  // Get values of arguments sent to hook (if needed)
  $pages = $event->arguments(0);
  $modified = $event->arguments(1);

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

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

$pages methods and properties

API reference based on ProcessWire core version 3.0.127

Twitter updates

  • New post: This week ProcessWire ProMailer has been released, plus we’ve got a nice upgrade in our community support forum, and more— More
    15 March 2019
  • New post: This week we look at the latest version of ProcessWire, 3.0.127 with nearly 30 new commits resolving dozens of older issue reports and a couple useful new features— More
    1 March 2019
  • New post: This week we take a look at what’s in ProcessWire 3.0.126 which focuses largely on resolving issue reports, but also includes a handy new Page if() method— More
    15 February 2019

Latest news

  • ProcessWire Weekly #253
    In the 253rd issue of ProcessWire Weekly we'll introduce the ProMailer Pro module, cover the upgrade made to our support forum software, check out Sanitizer Transliterate, and pick a new site of the week. Read on!
    Weekly.pw / 16 March 2019
  • ProcessWire ProMailer now available
    This week ProcessWire ProMailer has been released, plus we’ve got a nice upgrade in our community support forum, and more.
    Blog / 15 March 2019
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer