SettingsSection
in package
implements
SettingsSectionInterface, SettingsSectionUIPageProviderInterface
Base class for extensions that register a section under an existing WooCommerce settings page.
Tags
Interfaces, Classes and Traits
- SettingsSectionInterface
- Contract for extensions that register a section under an existing WooCommerce settings page.
- SettingsSectionUIPageProviderInterface
- Optional contract for registered sections that provide a native Settings UI page.
Table of Contents
- 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_ui_page() : SettingsUIPageInterface|null
- Get the native Settings UI page for this registered section.
Methods
get_save_adapter()
Get the default save adapter for fields in this section.
public
get_save_adapter(WC_Settings_Page $parent_page) : string
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_ui_page()
Get the native Settings UI page for this registered section.
public
get_settings_ui_page(WC_Settings_Page $parent_page) : SettingsUIPageInterface|null
Parameters
- $parent_page : WC_Settings_Page
-
Parent settings page.