FieldtypeRepeater::getCustomPageClass() method

Get custom RepeaterPage class for given repeater field

This method returns a custom RepeaterPage class that lives in the /site/classes directory, or it returns a class previously defined by a call to FieldtypeRepeater::setCustomPageClass(). It is unlikely you will ever need to call this method, as it is used internally. But the examples included here describe how to create and define the custom repeater page class files that this method would look for.

Available since version 3.0.235.

Example

// To use for field named "hello_world" add file:
// site/classes/HelloWorldRepeaterPage.php
// with the following contents (after opening PHP tag):
namespace ProcessWire;
class HelloWorldRepeaterPage extends RepeaterPage {
  // whatever you want here
}

// If using RepeaterMatrix then file would be:
// site/classes/HelloWorldRepeaterMatrixPage.php
// and contents would be:
namespace ProcessWire;
class HelloWorldRepeaterMatrixPage extends RepeaterMatrixPage {
  // whatever you want here
}

// If using FieldsetPage then file would be:
// site/classes/HelloWorldFieldsetPage.php
// and contents would be:
namespace ProcessWire;
class HelloWorldFieldsetPage extends FieldsetPage {
  // whatever you want here
}

Usage

$string = $fieldtypeRepeater->getCustomPageClass(Field $field);

Arguments

NameType(s)Description
fieldField

Your Repeater, RepeaterMatrix or FieldsetPage field

Return value

string

Returns the custom page class (with namespace)

See Also


FieldtypeRepeater methods and properties

API reference based on ProcessWire core version 3.0.236

Latest news

  • ProcessWire Weekly #550
    In the 550th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module called PagefileMetadata, and more. Read on!
    Weekly.pw / 23 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

“ProcessWire is like a breath of fresh air. So powerful yet simple to build with and customise, and web editors love it too.” —Margaret Chatwin, Web developer