SettingsSectionInterface
in
Contract for extensions that register a section under an existing WooCommerce settings page.
Tags
Table of Contents
- get_id() : string
- Get the section id.
- get_label() : string
- Get the section label.
- get_parent_page_id() : string
- Get the parent WooCommerce settings page id.
- get_save_adapter() : string
- Get the default save adapter for fields in this section.
- get_script_handles() : array<string|int, string>
- Get script handles that must be loaded before the settings UI app mounts.
- get_settings() : array<string|int, mixed>
- Get legacy settings for this section.
Methods
get_id()
Get the section id.
public
get_id() : string
Tags
Return values
string —get_label()
Get the section label.
public
get_label() : string
Tags
Return values
string —get_parent_page_id()
Get the parent WooCommerce settings page id.
public
get_parent_page_id() : string
Tags
Return values
string —get_save_adapter()
Get the default save adapter for fields in this section.
public
get_save_adapter(WC_Settings_Page $parent_page) : string
Supported values are form_post and none.
Parameters
- $parent_page : WC_Settings_Page
-
Parent settings page.
Tags
Return values
string —get_script_handles()
Get script handles that must be loaded before the settings UI app mounts.
public
get_script_handles(WC_Settings_Page $parent_page) : array<string|int, string>
Parameters
- $parent_page : WC_Settings_Page
-
Parent settings page.
Tags
Return values
array<string|int, string> —get_settings()
Get legacy settings for this section.
public
get_settings(WC_Settings_Page $parent_page) : array<string|int, mixed>
Parameters
- $parent_page : WC_Settings_Page
-
Parent settings page.