Automattic\WooCommerce\Admin\Settings

SettingsSection{} │ abstract │ WC 10.9.0└─ SettingsSectionInterface, SettingsSectionUIPageProviderInterface

Base class for extensions that register a section under an existing WooCommerce settings page.

No Hooks.

Usage

$SettingsSection = new SettingsSection();
// use class methods

Methods

1. public get_save_adapter( \WC_Settings_Page $parent_page )
2. public get_script_handles( \WC_Settings_Page $parent_page )
3. public get_settings_ui_page( \WC_Settings_Page $parent_page )

Changelog

SettingsSection{} SettingsSection{} code ^{WC 11.0.1}

abstract class SettingsSection implements SettingsSectionInterface, SettingsSectionUIPageProviderInterface {

	/**
	 * Get the native Settings UI page for this registered section.
	 *
	 * @since 11.0.0
	 *
	 * @param \WC_Settings_Page $parent_page Parent settings page.
	 * @return SettingsUIPageInterface|null
	 */
	public function get_settings_ui_page( \WC_Settings_Page $parent_page ): ?SettingsUIPageInterface {
		return null;
	}

	/**
	 * Get script handles that must be loaded before the settings UI app mounts.
	 *
	 * @since 10.9.0
	 *
	 * @param \WC_Settings_Page $parent_page Parent settings page.
	 * @return string[]
	 */
	public function get_script_handles( \WC_Settings_Page $parent_page ): array {
		return array();
	}

	/**
	 * Get the default save adapter for fields in this section.
	 *
	 * @since 10.9.0
	 *
	 * @param \WC_Settings_Page $parent_page Parent settings page.
	 * @return string
	 */
	public function get_save_adapter( \WC_Settings_Page $parent_page ): string {
		return 'form_post';
	}
}