FormBuilderEntries::deleteOlderThan() method

Delete entries older than a given number of days

Usage

// basic usage
$int = $formBuilderEntries->deleteOlderThan(int $age);

// usage with all arguments
$int = $formBuilderEntries->deleteOlderThan(int $age, string $ageType = 'DAYS', string $dateColumn = 'created', $flags = null);

Arguments

Name	Type(s)	Description
`age`	int	Age of entries (in DAYS by default)
`ageType` (optional)	string	Age type of YEARS, MONTHS, WEEKS, DAYS, HOURS, MINUTES or SECONDS (default=DAYS)
`dateColumn` (optional)	string	Column to examine: 'created' or 'modified' (default='created')
`flags` (optional)	int, null	Any flag that is required to match as well (negative flag to perform NOT match or 0 to match no flags set), see flag constants in this class (default=null)

Return value

int

Number of entries deleted

Exceptions

Method can throw exceptions on error:

WireException - If given invalid age type

Hooking FormBuilderEntries::deleteOlderThan(…)

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

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

  // Get values of arguments sent to hook (and optionally modify them)
  $age = $event->arguments(0);
  $ageType = $event->arguments(1);
  $dateColumn = $event->arguments(2);
  $flags = $event->arguments(3);

  /* Your code here, perhaps modifying arguments */

  // Populate back arguments (if you have modified them)
  $event->arguments(0, $age);
  $event->arguments(1, $ageType);
  $event->arguments(2, $dateColumn);
  $event->arguments(3, $flags);
});

Hooking after

The 'after' hooks are called immediately after each FormBuilderEntries::deleteOlderThan(…) method call is executed. This type of hook is especially useful for modifying the value that was returned by the method call.

$this->addHookAfter('FormBuilderEntries::deleteOlderThan', function(HookEvent $event) {
  // Get the object the event occurred on, if needed
  $FormBuilderEntries = $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)
  $age = $event->arguments(0);
  $ageType = $event->arguments(1);
  $dateColumn = $event->arguments(2);
  $flags = $event->arguments(3);

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

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

FormBuilderEntries methods and properties

API reference based on ProcessWire core version 3.0.236