SelectableOptionManager::setOptionsString()

Set an options string

Should adhere to the format

One option per line in the format: 123=title or 123=value|title where 123 is the option ID, 'value' is an optional value, and 'title' is a required title.

For new options, specify just the option title (or value|title) on its own line. Options should be in the desired sort order.

Usage

// basic usage
$array = $selectableOptionManager->setOptionsString(Field $field, string $value);

// usage with all arguments
$array = $selectableOptionManager->setOptionsString(Field $field, string $value, bool $allowDelete = true);

Arguments

NameType(s)Description
$fieldField
$valuestring
$allowDelete (optional)bool

Allow removed lines in the string to result in deleted options? If false, no options will be affected but you can call the getRemovedOptionIDs() method to retrieve them for confirmation.

Return value

array

containing ('added' => cnt, 'updated' => cnt, 'deleted' => cnt, 'marked' => cnt) note: 'marked' means marked for deletion


SelectableOptionManager methods and properties

API reference based on ProcessWire core version 3.0.251