CommentList::options() method

Get or set options

Available since version 3.0.138.

// basic usage
$array = $commentList->options();

// usage with all arguments
$array = $commentList->options($key = null, $value = null);

Name Type(s) Description

Name	Type(s)	Description
`key` (optional)	string, null, array	Use one of the following: Omit to get array of all options Specify option name to get (and omit $value argument) Specify option name to set and provide a non-null $value argument Specify array of one or more [ 'option' => 'value' ] to set and omit $value argument
`value` (optional)	string, int, bool, null	When setting an individual option, value should be specified here, otherwise omit

key (optional)

string, null, array

Use one of the following:

Omit to get array of all options
Specify option name to get (and omit $value argument)
Specify option name to set and provide a non-null $value argument
Specify array of one or more [ 'option' => 'value' ] to set and omit $value argument

value (optional)

string, int, bool, null

When setting an individual option, value should be specified here, otherwise omit

array string int bool null

When getting singe option, value is returned, otherwise array of all options is returned.

API reference based on ProcessWire core version 3.0.244