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

Latest news

  • ProcessWire Weekly #550
    In the 550th issue of ProcessWire Weekly we're going to check out the latest core updates, introduce a new third party module called PagefileMetadata, and more. Read on!
    Weekly.pw / 23 November 2024
  • Custom Fields Module
    This week we look at a new ProFields module named Custom Fields. This module provides a way to rapidly build out ProcessWire fields that contain any number of subfields/properties within them.
    Blog / 30 August 2024
  • Subscribe to weekly ProcessWire news

I just love the easy and intuitive ProcessWire API. ProcessWire rocks!” —Jens Martsch, Web developer