$plugin_name
$plugin_name : string
The unique identifier of this plugin.
Manage the settings of the plugin.
Provide methods to set and get plugin settings fields and to create the respective admin page and menu entry. *
specify_page(string $id, string $title, callable $callback = null)
Specify a section of the form.
Keeps a record of all sections in $this->sections.
string | $id | Slug-name to identify the page. |
string | $title | Formatted title of the section. Shown as the heading for the section. |
callable | $callback | Function that echos out the any content at the top of the page (before the first section). |
specify_section(string $id, string $title, callable $callback, string $page, callable $summary_callback = null)
Specify a section of the form.
Keeps a record of all sections in $this->sections.
string | $id | Slug-name to identify the section. Used in the 'id' attribute of tags. |
string | $title | Formatted title of the section. Shown as the heading for the section. |
callable | $callback | Function that echos out any content at the top of the section (between heading and fields). |
string | $page | The slug-name of the page on which to show the section. |
callable | $summary_callback | Callback to call when composing the summary of this form. |
specify_field(string $id, string $title, callable $callback, string $page, string $section, array $args, callable $validation_callable, string $default, integer $max_length = false)
Specify a field of the form.
Keeps a record of all fields in $this->fields.
string | $id | Slug-name to identify the field. Used in the 'id' attribute of tags. |
string | $title | Formatted title of the field. Shown as the heading for the field. |
callable | $callback | Function that echos out any content at the top of the field (between heading and fields). |
string | $page | The slug-name of the page on which to show the field. |
string | $section | The slug-name of the section in which to show the field. |
array | $args | { Extra arguments used when outputting the field. May be an empty array().
} |
callable | $validation_callable | Callable to use during validation of inputs. Must take a field ID and input as parameters and return a valid value for the field. Should call $this->add_error() to indicate problems. |
string | $default | Default value for the field. |
integer | $max_length | Maximum length of the value of the field. |
render_single_line_field(string $id, string|null $placeholder = null, string $autocomplete = 'on', string $style = false, string $label = false, boolean $esc_label = true, string $label_style = false)
Render a standard text box type field.
string | $id | Id of the field. |
string|null | $placeholder | Placeholder text (default is null). |
string | $autocomplete | Whether to auto complete 'or' (default) or 'off. |
string | $style | CSS style. |
string | $label | HTML label. |
boolean | $esc_label | Whether to escape the content of label. |
string | $label_style | CSS style for the label. |
render_multi_line_field(string $id, integer $rows = false, string $style = false, boolean $preview = false, string $placeholder = false)
Render a multi line text box type field.
string | $id | Id of the field. |
integer | $rows | Number of rows |
string | $style | CSS style |
boolean | $preview | Whether to show a LaTeX preview below the field. |
string | $placeholder | Placeholder |
render_checkbox_field(string $id, string $label = '', boolean $esc_label = true)
Render a checkbox type field.
string | $id | Id of the field. |
string | $label | Label of the field. |
boolean | $esc_label | Whether to escape the content of $label, disable in case you want $label to contains htmls |
render_array_as_comma_separated_list_field(string $id, string $placeholder = null)
Render an array as comma separated list type field.
Does not escape or otherwise handle individual fields that contain commas.
string | $id | Id of the field. |
string | $placeholder | Placeholder text. |
specify_fake_field(string $id, string $default)
Add a fake field
Fake fields cannot be modified, but have default values that can be used to avoid hard coding values.
string | $id | Slug-name to identify the section. Used in the 'id' attribute of tags. |
string | $default | Default value for the field. |
instance(string $plugin_name = null, string $plugin_pretty_name = null, string $version = null, callback $active_post_type_names_callback = null) : \O3PO_Settings
Returns the settings singleton.
Also checks whether it has been configured.
string | $plugin_name | Simple name of this plugin. |
string | $plugin_pretty_name | Pretty name of this plugin. |
string | $version | Version of this plugin. |
callback | $active_post_type_names_callback | The callback from which to get the active post type names. |
The settings singleton.
trim_ensure_not_empty_and_schedule_flush_rewrite_rules_if_changed(string $id, string $input)
Trim user input to special fields connected to rewrite rules.
Ensure the rewrite rules are flushed when such setting is changed.
string | $id | The field this was input to. |
string | $input | User input. |
add_error(string $setting, string $code, string $message, string $type = 'error')
Record errors during input verification.
Calls through to WP's add_settings_error().
string | $setting | Slug title of the setting to which this error applies. |
string | $code | Slug-name to identify the error. Used as part of 'id' attribute in HTML output. |
string | $message | The formatted message text to display to the user (will be shown inside styled and tags). |
string | $type | Message type, controls HTML class. Possible values include 'error', 'success', 'warning', 'info'. Default value: 'error' |
configure(string $plugin_name, string $plugin_pretty_name, string $version, callback $active_post_type_names_callback)
Configure the settings singleton.
string | $plugin_name | Simple name of this plugin. |
string | $plugin_pretty_name | Pretty name of this plugin. |
string | $version | Version of this plugin. |
callback | $active_post_type_names_callback | The callback from which to get the active post type names. |