$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, $time = null, string $type = 'modified');

Arguments

NameType(s)Description
pagesPage, PageArray, array

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

time (optional)null, int, string

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

type (optional)string

Date type to update, one of 'modified', 'created' or 'published' (default='modified') Added 3.0.146

Return value

bool

True on success, false on fail

Exceptions

Method can throw exceptions on error:

  • WireException or \PDOException - 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);
  $time = $event->arguments(1);
  $type = $event->arguments(2);

  /* Your code here, perhaps modifying arguments */

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

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);
  $time = $event->arguments(1);
  $type = $event->arguments(2);

  /* 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.178

Twitter updates

  • Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we’ll take a closer look at in this post— More
    11 June 2021
  • ProcessWire 3.0.179 adds great new admin theme customization tools that put you in full control over the Uikit admin styles— More
    28 May 2021
  • ProcessWire updates for week of 21 May 2021— More
    22 May 2021

Latest news

  • ProcessWire Weekly #370
    In the 370th issue of ProcessWire Weekly we're going to check out the latest version of the commercial FormBuilder module, introduce a couple of brand new third party modules, and more. Read on!
    Weekly.pw / 12 June 2021
  • ProcessWire FormBuilder v50 updates
    Today a new version of FormBuilder has been released in the FormBuilder support board (our 50th version) and it has a lot of interesting new features, which we'll take a closer look at in this post.
    Blog / 11 June 2021
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits