Option Package Installation Plugin#
Registers new options. Options allow the administrator to configure the behaviour of installed packages. The specified values are exposed as PHP constants.
Each category is described as an
<category> element with the mandatory attribute
The category’s parent category.
Specifies the order of this option within the parent category.
The options element can contain a comma-separated list of options of which at least one needs to be enabled for the category to be shown to the administrator.
Each option is described as an
<option> element with the mandatory attribute
name is transformed into a PHP constant name by uppercasing it.
The option’s category.
The type of input to be used for this option.
Valid types are defined by the
The value that is set after installation of a package.
Valid values are defined by the
Defines a regular expression that is used to validate the value of a free form option (such as
Specifies the order of this option within the category.
Defined only for
Specifies a newline-separated list of selectable values.
Each line consists of an internal handle, followed by a colon (
:, U+003A), followed by a language item.
The language item is shown to the administrator, the internal handle is what is saved and exposed to the code.
Defined only for
Specifies a comma-separated list of options which should be visually enabled when this option is enabled.
A leading exclamation mark (
!, U+0021) will disable the specified option when this option is enabled.
radioButton types the list should be prefixed by the internal
selectoptions handle followed by a colon (
This setting is a visual helper for the administrator only. It does not have an effect on the server side processing of the option.
hidden is set to
1 the option will not be shown to the administrator.
It still can be modified programmatically.
The options element can contain a comma-separated list of options of which at least one needs to be enabled for the option to be shown to the administrator.
Specifies whether this option supports localized input.
Specifies whether this option requires localized input (i.e. the administrator must specify a value for every installed language).
Additional fields may be defined by specific types of options. Refer to the documentation of these for further explanation.
All relevant language items have to be put into the
wcf.acp.option language item category.
If you install a category named
example.sub, you have to provide the language item
wcf.acp.option.category.example.sub, which is used when displaying the options.
If you want to provide an optional description of the category, you have to provide the language item
Descriptions are only relevant for categories whose parent has a parent itself, i.e. categories on the third level.
If you install an option named
module_example, you have to provide the language item
wcf.acp.option.module_example, which is used as a label for setting the option value.
If you want to provide an optional description of the option, you have to provide the language item