InputfieldPageListSelect

InputfieldPageListSelect

InputfieldPageListSelectMultiple

Single selection (InputfieldPageListSelect)

The value is a single integer page ID. setAttribute('value', ...) accepts a Page object, an integer ID, a numeric string, or an array (first element is used). All values are cast to int.

// Set by page ID
$f->attr('value', 1234);

// Set by Page object
$f->attr('value', $pages->get('/some-page/'));

// Get current value
$id = $f->val(); // int, e.g. 1042

isEmpty() returns true when the value is less than 1 (i.e. no page selected).

Multiple selection (InputfieldPageListSelectMultiple)

The value is an array of integer page IDs. The array preserves the user's sort order (implements InputfieldHasSortableValue). Submitted values arrive as a comma-separated string which is split and cast to integers during processInput().

// Set by array of page IDs
$f->attr('value', [1042, 1055, 1099]);

// Get current values
$ids = $f->val(); // array, e.g. [1042, 1055, 1099]

The multi-select variant implements InputfieldHasArrayValue — its value is always an array, even when empty ([]).

renderMarkupValue($value)

Renders the selected page label(s) as non-editable markup for display contexts (e.g. when the page is not being edited). Called internally by ___renderValue().

// Single: renders a <p> with the page label
// Multiple: renders a <ul> with <li> per selected page
echo $f->renderMarkupValue($f->val());

getPageLabel(Page $page)

Returns a sanitized, entity-encoded label string for a given page. Uses the configured labelFieldName, falling back to the page's name if the label field is empty. If the page is not viewable, returns a "Page N not viewable" message.

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

When the Inputfield is used as a delegate of InputfieldPage (i.e. $f->hasInputfield is an InputfieldPage instance), this method delegates to InputfieldPage::getPageLabel() for consistent label formatting.

renderParentError()

Returns an error message string when parent_id is not configured. Called automatically by ___render() when parent_id is empty or 0.

// Returns: "<p class='error'>Unable to render this field due to missing parent page in field settings.</p>"

pageListReady($name, $labelFieldName)

Initializes the ProcessPageList module and configures it with the given field name and label field. Called internally during renderReady(). If already initialized (lazy-loaded), subsequent calls are no-ops.

Both variants render a hidden <input type="text"> element that holds the current value(s), combined with JavaScript-driven page tree markup provided by ProcessPageList. The input element carries data- attributes that configure the tree widget:

The multi-select variant additionally renders an <ol> containing <li> elements for each selected page, with sort handles and remove buttons.

• InputfieldPageListSelection — marker interface indicating the Inputfield provides tree-based page selection capabilities (shared by both variants).
• InputfieldHasArrayValue — implemented by InputfieldPageListSelectMultiple; value is always an array.
• InputfieldHasSortableValue — implemented by InputfieldPageListSelectMultiple; selected page order is user-sortable and preserved.

// Hook after multi-select processing to add custom validation
$wire->addHookAfter('InputfieldPageListSelectMultiple::processInput', function(HookEvent $event) {
    $inputfield = $event->object;
    $selectedIds = $inputfield->val();
    if(count($selectedIds) > 5) {
        $inputfield->error('You may select at most 5 pages.');
    }
});

• parent_id controls the root of the selectable tree. The default 0 renders from the page-tree root; an empty string displays an error message in the admin.
• The parent_id here refers to the root of the selectable tree, not a direct parent — this is the semantic defined by the InputfieldPageListSelection interface.
• Both variants depend on the ProcessPageList module, which is loaded automatically during renderReady().
• The label field is used both in the tree during selection and in the display-only rendered value.
• When used as a delegate of InputfieldPage, labels and selectable-page logic are handled by the parent InputfieldPage rather than the page-list widget itself.
• The multi-select variant uses jQuery UI sortable for drag-to-reorder; the output list is populated from the page tree via ProcessPageList events.
• Source files:
  • wire/modules/Inputfield/InputfieldPageListSelect/InputfieldPageListSelect.module
  • wire/modules/Inputfield/InputfieldPageListSelect/InputfieldPageListSelectMultiple.module
  • wire/modules/Inputfield/InputfieldPageListSelect/InputfieldPageListSelectCommon.php