InputfieldPage

The value attribute is a PageArray by default, even for a single selection. When derefAsPage is enabled, the value is a single Page.

$value = $f->attr('value'); // PageArray by default
foreach($value as $page) {
    echo $page->title;
}

Accepted assignment formats include:

$f->attr('value', 1234);          // page ID
$f->attr('value', '123|456|789'); // pipe-separated page IDs
$f->attr('value', $page);         // Page
$f->attr('value', $pageArray);    // PageArray

Integer IDs and pipe-separated ID strings are converted to a PageArray. Passing a Page or PageArray stores that object as the value.

At least one selectable-page constraint should usually be configured: parent_id, template_id / template_ids, findPagesSelector, or findPagesSelect.

getSelectablePages($page, $filterSelector = '')

Returns a PageArray of pages selectable for the page being edited. This is the preferred hook point for custom selectable-page logic.

$wire->addHookAfter('InputfieldPage::getSelectablePages', function(HookEvent $event) {
    $inputfield = $event->object; /** @var InputfieldPage $inputfield */
    $page = $event->arguments(0);
    if($inputfield->hasField == 'related_products') {
        $event->return = $event->pages->find('template=product, featured=1');
    }
});

The optional $filterSelector argument was added in ProcessWire 3.0.245 and narrows the result with an additional selector.

Selectable pages can come from, in broad precedence order:

1. findPagesSelector / findPagesSelect
2. deprecated findPagesCode
3. children of parent_id
4. pages matching template_id / template_ids

The page currently being edited is removed from the selectable set to prevent a page from referencing itself.

getPageLabel(Page $page, $allowMarkup = false)

Returns the option label for a page, using labelFieldName or labelFieldFormat. Unpublished pages receive an (unpublished) suffix.

$label = $f->getPageLabel($somePage);

renderPageLabel(Page $page, $allowMarkup = false)

Hookable implementation used by getPageLabel() when hooks are present.

$wire->addHookAfter('InputfieldPage::renderPageLabel', function(HookEvent $event) {
    $page = $event->arguments(0);
    $event->return = $page->title . ' (' . $page->parent->title . ')';
});

createFindPagesSelector(array $options = [])

Builds the effective selector from configured properties.

$selector = $f->createFindPagesSelector([ 'page' => $editPage ]);
// Example: parent_id=1042, templates_id=29, include=hidden

Options:

getTemplateIDs($getString = false)

Returns configured template IDs as an array, or as a 1|2|3 string when $getString is true.

$ids = $f->getTemplateIDs();
$str = $f->getTemplateIDs(true);

findPagesSelector and findPagesSelect can reference values from the page being edited:

parent=page.section, template=article

page.field and item.field placeholders are populated at render/process time. When the placeholder refers to a page ID value and that value is empty, the value is replaced with -1 so the selector intentionally matches nothing. Empty non-ID subfields are replaced with an empty value.

getInputfield()

Returns the configured delegate Inputfield instance, populated with current value, selectable options, selector information, and relevant settings. Returns null if inputfield does not name a valid Inputfield module.

render()

Renders the delegate Inputfield and inline-add UI when enabled. If no valid delegate is configured, it returns the input name and records an error during renderReady().

renderValue()

Renders selected page labels for non-editable display. Multiple values render as a <ul class="PageArray pw-bullets">.

processInput(WireInputData $input)

Delegates processing to the configured inputfield, validates submitted page IDs, normalizes the value to PageArray or Page, and processes inline-added pages when enabled.

isValidPage(Page $page, $field, ?Page $editPage = null)

Static validation helper used primarily by FieldtypePage. It validates parent, template, selector, and self-reference constraints, but does not validate deprecated findPagesCode results.

if(InputfieldPage::isValidPage($page, $field, $editPage)) {
    // page may be selected
}

When addable is enabled, parent_id and template_id are configured, and labelFieldName is empty or title, the rendered input may include controls for creating new selectable pages. Access is checked against the parent and new page. Existing sibling pages with matching titles are reused rather than duplicated.

• Access this inputfield with $modules->get('InputfieldPage').
• It is normally created by FieldtypePage; manual construction is uncommon.
• The inputfield property must identify a compatible delegate Inputfield.
• findPagesCode is deprecated; hook getSelectablePages() instead.
• isEmpty() returns true when no page is selected.
• Companion classes include FieldtypePage, InputfieldSelect, InputfieldAsmSelect, InputfieldPageListSelect, InputfieldPageAutocomplete, and InputfieldTextTags.

Source file: wire/modules/Inputfield/InputfieldPage/InputfieldPage.module