WooCommerce Code Reference

WC_Settings_Rest_API extends WC_Settings_Advanced
in package

WC_Settings_Rest_API class.

Tags
deprecated
3.4

in favour of WC_Settings_Advanced.

Table of Contents

TYPE_CHECKBOX  = 'checkbox'
TYPE_COLOR  = 'color'
TYPE_DATE  = 'date'
TYPE_DATETIME  = 'datetime'
TYPE_DATETIME_LOCAL  = 'datetime-local'
TYPE_EMAIL  = 'email'
TYPE_IMAGE_WIDTH  = 'image_width'
TYPE_INFO  = 'info'
TYPE_MONTH  = 'month'
TYPE_MULTI_SELECT_COUNTRIES  = 'multi_select_countries'
TYPE_MULTISELECT  = 'multiselect'
TYPE_NUMBER  = 'number'
TYPE_PASSWORD  = 'password'
TYPE_RADIO  = 'radio'
TYPE_RELATIVE_DATE_SELECTOR  = 'relative_date_selector'
TYPE_SECTIONEND  = 'sectionend'
TYPE_SELECT  = 'select'
TYPE_SINGLE_SELECT_COUNTRY  = 'single_select_country'
TYPE_SINGLE_SELECT_PAGE  = 'single_select_page'
TYPE_SINGLE_SELECT_PAGE_WITH_SEARCH  = 'single_select_page_with_search'
TYPE_SLOTFILL_PLACEHOLDER  = 'slotfill_placeholder'
TYPE_TEL  = 'tel'
TYPE_TEXT  = 'text'
TYPE_TEXTAREA  = 'textarea'
TYPE_TIME  = 'time'
TYPE_TITLE  = 'title'
Setting field types.
TYPE_URL  = 'url'
TYPE_WEEK  = 'week'
$icon  : string
Setting page icon.
$id  : string
Setting page id.
$is_modern  : bool
Setting page is modern.
$label  : string
Setting page label.
$types  : array<string|int, string>
Settings field types which are known.
$output_called  : bool
Whether the output method has been called.
__construct()  : mixed
Constructor.
add_settings_page()  : mixed
Add this page to settings.
add_settings_page_data()  : array<string|int, mixed>
Get page settings data to populate the settings editor.
add_settings_slot()  : mixed
Creates the React mount point for settings slot.
form_method()  : string
Form method.
get_custom_type_field()  : array<string|int, mixed>
Get the custom type field by calling the action and returning the setting with the content, id, and type.
get_custom_view()  : string
Get the custom view given the current tab and section.
get_id()  : string
Get settings page ID.
get_label()  : string
Get settings page label.
get_sections()  : array<string|int, mixed>
Get all sections for this page, both the own ones and the ones defined via filters.
get_settings()  : array<string|int, mixed>
Get settings array for the default section.
get_settings_for_section()  : array<string|int, mixed>
Get settings array.
output()  : mixed
Output the HTML for the settings.
output_sections()  : mixed
Output sections.
save()  : mixed
Save settings and trigger the 'woocommerce_update_options_'.id action.
do_update_options_action()  : mixed
Trigger the 'woocommerce_update_options_'.id action.
get_own_sections()  : array<string|int, mixed>
Get own sections for this page.
get_section_settings_data()  : array<string|int, mixed>
Get settings data for a specific section.
get_settings_for_blueprint_section()  : array<string|int, mixed>
Get settings for the Blueprint section.
get_settings_for_default_section()  : array<string|int, mixed>
Get settings for the default section.
get_settings_for_legacy_api_section()  : array<string|int, mixed>
Get settings for the legacy API section.
get_settings_for_section_core()  : array<string|int, mixed>
Get the settings for a given section.
get_settings_for_woocommerce_com_section()  : array<string|int, mixed>
Get settings for the WooCommerce.com section.
populate_setting_value()  : array<string|int, mixed>
Populate the value for a given section setting.
save_settings_for_current_section()  : mixed
Save settings for current section.
notices()  : mixed
Notices.

Constants

Properties

$types

Settings field types which are known.

protected array<string|int, string> $types = array(self::TYPE_TITLE, self::TYPE_INFO, self::TYPE_SECTIONEND, self::TYPE_TEXT, self::TYPE_PASSWORD, self::TYPE_DATETIME, self::TYPE_DATETIME_LOCAL, self::TYPE_DATE, self::TYPE_MONTH, self::TYPE_TIME, self::TYPE_WEEK, self::TYPE_NUMBER, self::TYPE_EMAIL, self::TYPE_URL, self::TYPE_TEL, self::TYPE_COLOR, self::TYPE_TEXTAREA, self::TYPE_SELECT, self::TYPE_MULTISELECT, self::TYPE_RADIO, self::TYPE_CHECKBOX, self::TYPE_IMAGE_WIDTH, self::TYPE_SINGLE_SELECT_PAGE, self::TYPE_SINGLE_SELECT_PAGE_WITH_SEARCH, self::TYPE_SINGLE_SELECT_COUNTRY, self::TYPE_MULTI_SELECT_COUNTRIES, self::TYPE_RELATIVE_DATE_SELECTOR, self::TYPE_SLOTFILL_PLACEHOLDER)

Methods

add_settings_page()

Add this page to settings.

public add_settings_page(array<string|int, mixed> $pages) : mixed
Parameters
$pages : array<string|int, mixed>

The settings array where we'll add ourselves.

Return values
mixed —

add_settings_page_data()

Get page settings data to populate the settings editor.

public add_settings_page_data(array<string|int, mixed> $pages) : array<string|int, mixed>
Parameters
$pages : array<string|int, mixed>

The settings array where we'll add data.

Return values
array<string|int, mixed> —

get_custom_type_field()

Get the custom type field by calling the action and returning the setting with the content, id, and type.

public get_custom_type_field(string $action, array<string|int, mixed> $setting) : array<string|int, mixed>
Parameters
$action : string

The action to call.

$setting : array<string|int, mixed>

The setting to pass to the action.

Return values
array<string|int, mixed> — The setting with the content, id, and type.

get_custom_view()

Get the custom view given the current tab and section.

public get_custom_view(string $action[, string $section_id = false ]) : string
Parameters
$action : string

The action to call.

$section_id : string = false

The section id.

Return values
string — The custom view. HTML output.

get_settings()

Get settings array for the default section.

public get_settings() : array<string|int, mixed>

External settings classes (registered via 'woocommerce_get_settings_pages' filter) might have redefined this method as "get_settings($section_id='')", thus we need to use this method internally instead of 'get_settings_for_section' to register settings and render settings pages.

But we can't just redefine the method as "get_settings($section_id='')" here, since this will break on PHP 8 if any external setting class have it as 'get_settings()'.

Thus we leave the method signature as is and use 'func_get_arg' to get the setting id if it's supplied, and we use this method internally; but it's deprecated and should otherwise never be used.

Tags
deprecated
5.4.0

Use 'get_settings_for_section' (passing an empty string for default section)

Return values
array<string|int, mixed> — Settings array, each item being an associative array representing a setting.

get_settings_for_section()

Get settings array.

public final get_settings_for_section(string $section_id) : array<string|int, mixed>

The strategy for getting the settings is as follows:

  • If a method named 'get_settings_for_{section_id}_section' exists in the class it will be invoked (for the default '' section, the method name is 'get_settings_for_default_section'). Derived classes can implement these methods as required.

  • Otherwise, 'get_settings_for_section_core' will be invoked. Derived classes can override it as an alternative to implementing 'get_settings_for_{section_id}_section' methods.

Parameters
$section_id : string

The id of the section to return settings for, an empty string for the default section.

Return values
array<string|int, mixed> — Settings array, each item being an associative array representing a setting.

do_update_options_action()

Trigger the 'woocommerce_update_options_'.id action.

protected do_update_options_action([string $section_id = null ]) : mixed
Parameters
$section_id : string = null

Section to trigger the action for, or null for current section.

Return values
mixed —

get_own_sections()

Get own sections for this page.

protected get_own_sections() : array<string|int, mixed>

Derived classes should override this method if they define sections. There should always be one default section with an empty string as identifier.

Example: return array( '' => __( 'General', 'woocommerce' ), 'foobars' => __( 'Foos & Bars', 'woocommerce' ), );

Return values
array<string|int, mixed> — An associative array where keys are section identifiers and the values are translated section names.

get_section_settings_data()

Get settings data for a specific section.

protected get_section_settings_data(string $section_id, array<string|int, mixed> $sections) : array<string|int, mixed>
Parameters
$section_id : string

The ID of the section.

$sections : array<string|int, mixed>

All sections available.

Return values
array<string|int, mixed> — Settings data for the section.

get_settings_for_section_core()

Get the settings for a given section.

protected get_settings_for_section_core(string $section_id) : array<string|int, mixed>

This method is invoked from 'get_settings_for_section' when no 'get_settings_for_{current_section}_section' method exists in the class.

When overriding, note that the 'woocommerce_get_settings_' filter must NOT be triggered, as this is already done by 'get_settings_for_section'.

Parameters
$section_id : string

The section name to get the settings for.

Return values
array<string|int, mixed> — Settings array, each item being an associative array representing a setting.

get_settings_for_woocommerce_com_section()

Get settings for the WooCommerce.com section.

protected get_settings_for_woocommerce_com_section() : array<string|int, mixed>
Return values
array<string|int, mixed> —

populate_setting_value()

Populate the value for a given section setting.

protected populate_setting_value(array<string|int, mixed> $section_setting) : array<string|int, mixed>
Parameters
$section_setting : array<string|int, mixed>

The setting array to populate.

Return values
array<string|int, mixed> — The setting array with populated value.