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