FieldtypeRepeater::deleteRepeaterPage()

Delete a repeater page, removing system statuses first

This is able to delete the following types of pages:

  • repeaters/for-field-123/
  • repeaters/for-field-123/for-page-456/
  • repeaters/for-field-123/for-page-456/repeater-item/
  • repeaters/for-field-123/for-page-456/repeater-item/something-else/

Available since version 3.0.188.

Usage

// basic usage
$int = $fieldtypeRepeater->deleteRepeaterPage(Page $page);

// usage with all arguments
$int = $fieldtypeRepeater->deleteRepeaterPage(Page $page, $field = null, bool $recursive = false);

Arguments

NameType(s)Description
$pagePage
$field (optional)Field null

Optionally limit to given field or null if not appliable

$recursive (optional)bool

Descend to children?

Return value

int

Returns count of pages deleted, or 0 if delete not allowed

FieldtypeRepeater methods and properties

API reference based on ProcessWire core version 3.0.252