Automattic\WooCommerce\Admin\Settings

SettingsUIPageInterface{} │ interface │ WC 10.9.0

Contract for settings pages that opt into the settings UI renderer.

Хуков нет.

Использование

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

Методы

1. public get_page_id()
2. public get_save_adapter( string $section )
3. public get_schema( string $section )
4. public get_script_handles( string $section )

Список изменений

Код SettingsUIPageInterface{} SettingsUIPageInterface{} ^{WC 11.2.2}

interface SettingsUIPageInterface {

	/**
	 * Get the stable page id used for scoping the settings UI.
	 *
	 * @since 10.9.0
	 *
	 * @return string
	 */
	public function get_page_id(): string;

	/**
	 * Build the canonical settings schema for a section.
	 *
	 * The `shell.sectionNavigation` key controls the sibling-section navigation
	 * rendered by the Settings UI shell, and only applies to drill-down pages
	 * (sections of the Payments tab). Set a custom array of `id`/`label`/`href`/
	 * `active` entries to own the navigation, or omit the key to render none;
	 * drill-down pages default to header breadcrumbs instead. Top-level settings
	 * pages render the classic section links and ignore this key.
	 *
	 * @since 10.9.0
	 *
	 * @param string $section Section id. Empty string means the default section.
	 * @return array
	 */
	public function get_schema( string $section ): array;

	/**
	 * Get script handles that must be loaded before the settings UI app mounts.
	 *
	 * @since 10.9.0
	 *
	 * @param string $section Section id. Empty string means the default section.
	 * @return string[]
	 */
	public function get_script_handles( string $section ): array;

	/**
	 * Get the default save adapter for fields on this page.
	 *
	 * Supported values are `form_post` and `none`.
	 *
	 * @since 10.9.0
	 *
	 * @param string $section Section id. Empty string means the default section.
	 * @return string
	 */
	public function get_save_adapter( string $section ): string;
}