SelectableOptionManager::setOptionsString() method

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.244

Latest news

  • ProcessWire Weekly #558
    In the 558th issue of ProcessWire Weekly we'll check out the blog post that introduces ProcessWire 3.0.244, share some recent ProcessWire highlights, and more. Read on!
    Weekly.pw / 18 January 2025
  • ProcessWire 3.0.244 new main/master version
    ProcessWire 3.0.244 is our newest main/master/stable version. It's been more than a year in the making and is packed with tons of new features, issue fixes, optimizations and more. This post covers all the details.
    Blog / 18 January 2025
  • Subscribe to weekly ProcessWire news

“…building with ProcessWire was a breeze, I really love all the flexibility the system provides. I can’t imagine using any other CMS in the future.” —Thomas Aull