SelectableOptionManager::setOptions() method

Set current options for $field, identify and acting on added, deleted, updated options

Usage

// basic usage
$array = $selectableOptionManager->setOptions(Field $field, $options);

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

Arguments

NameType(s)Description
fieldField
optionsarray, SelectableOptionArray

Array of SelectableOption objects For new options specify 0 for the 'id' property.

allowDelete (optional)bool

Allow options to be deleted? If false, the options marked for deletion can be retrieved via $this->getRemovedOptions($field);

Return value

array

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

Exceptions

Method can throw exceptions on error:

  • WireException


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

“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