Instellingen en quick start hooks

Deze pagina toont de 19 hooks van deze groep. Elke hook laat zijn type zien, de versie waarin hij verscheen, waar hij draait, zijn argumenten en een beginpunt.

• adba_admin_presets
• adba_field_types
• adba_register_fields
• adba_role_default_mode
• adba_settings_card_section
• adba_settings_card_width
• adba_settings_imported
• adba_settings_index
• adba_settings_merged_tabs
• adba_settings_panel_keys
• adba_settings_saved
• adba_settings_schema
• adba_settings_sections
• adba_settings_tabs
• adba_setup_links
• adba_setup_presets
• adba_setup_steps
• adba_setup_woocommerce_cards
• adba_user_prefs

adba_admin_presets

FilterSinds 2.18.0 Draait in src/Setup/AdminPresets.php.

Filtert de beheerpresets van de quick start. Voeg een preset toe of wijzig er een: elke preset is een array met label, description, preview (labels), role_modes (rol => advanced, simple of focus), role_profiles (rol => profiel van de weergave Simple, sinds 2.24.0), simple (type => item => zichtbaar in elk profiel van de weergave Simple) en hidden (type => item => rollen waarvoor het verborgen is).

Argument	Type	Beschrijving
$presets	array<string, array<string, mixed>>	Presets op id.

add_filter( 'adba_admin_presets', function ( $presets ) {
	return $presets;
} );

adba_field_types

FilterSinds 1.3.0 Draait in src/Settings/Schema.php.

Filtert de complete lijst veldtypes na de registratie.

Items die geen FieldInterface zijn, worden genegeerd. Het type text bestaat altijd, als terugval voor onbekende types.

Argument	Type	Beschrijving
$fields	array<string, FieldInterface>	Veldtypes op type.

add_filter( 'adba_field_types', function ( $fields ) {
	return $fields;
} );

adba_register_fields

ActionSinds 1.3.0 Draait in src/Settings/Schema.php.

Vuurt wanneer het instellingenschema wordt gemaakt, voordat een schema wordt genormaliseerd.

Roep $schema->register_field( new My_Field() ) aan om een veldtype toe te voegen. Een type registreren dat al bestaat vervangt het: de laatste registratie wint.

Argument	Type	Beschrijving
$schema	Schema	De schemaservice.

add_action( 'adba_register_fields', function ( $schema ) {
	// ...
} );

adba_role_default_mode

FilterSinds 2.6.0 Draait in src/Settings/Prefs.php.

Filtert de standaardweergave van een gebruiker die er geen heeft gekozen: advanced, simple of focus. De waarde is de roldefault uit Addofy > Uiterlijk, of null als er geen geldt. Geef null terug om de sitestandaard te gebruiken. De eigen keuze van de gebruiker wint altijd.

Argument	Type	Beschrijving
$mode	string|null	Standaardweergave van de rol, of null.
$user_id	int	Gebruikers-id.

add_filter( 'adba_role_default_mode', function ( $mode, $user_id ) {
	return $mode;
}, 10, 2 );

adba_settings_card_section

FilterSinds 2.4.0 Draait in src/Modules/Settings/ModulesTab.php.

Filtert de sectie waarin een modulekaart staat op de tab Modules.

Argument	Type	Beschrijving
$section	string	Sectie-id, zie adba_settings_sections.
$module_id	string	Module-id.

add_filter( 'adba_settings_card_section', function ( $section, $module_id ) {
	return $section;
}, 10, 2 );

adba_settings_card_width

FilterSinds 1.2.0 Draait in src/Modules/Settings/ModulesTab.php.

Filtert de breedte van een modulekaart op de tab Modules.

Argument	Type	Beschrijving
$width	string	'full' voor de hele rij, '' voor het raster met drie kolommen.
$module_id	string	Module-id.

add_filter( 'adba_settings_card_width', function ( $width, $module_id ) {
	return $width;
}, 10, 2 );

adba_settings_imported

ActionSinds 1.3.0 Draait in src/Settings/Transfer.php.

Vuurt nadat een import is toegepast, vanuit de tab Hulpmiddelen of met wp adba settings import.

Extensie-instellingen staan onder settings.module_settings, dus ze maken deel uit van de payload.

Argument	Type	Beschrijving
$payload	array<string, mixed>	Toegepaste payload: instellingen, zichtbaarheid, menu.
$diff	array<int, array{area: string, label: string, change: string}>	Wat er veranderde, zoals getoond in het voorbeeld.
$skipped	string[]	Instellingssleutels die vastliggen door een constante of omgevingsvariabele.

add_action( 'adba_settings_imported', function ( $payload, $diff, $skipped ) {
	// ...
}, 10, 3 );

adba_settings_index

FilterSinds 2.30.0 Draait in src/Modules/Settings/SettingsIndex.php.

Filtert de items van de zoekfunctie voor instellingen (instellingenpagina en command palette). Voeg een item toe voor een instelling op je eigen tab, zodat de zoekfunctie die vindt. Elk item is een array met key (configsleutel of ''), label, description, place (naam van de tab of module) en url (admin-URL, met #id van de rij om die te markeren). Items zonder label of url vallen weg.

Argument	Type	Beschrijving
$entries	array<int, array<string, string>>	Items.

add_filter( 'adba_settings_index', function ( $entries ) {
	return $entries;
} );

adba_settings_merged_tabs

FilterSinds 2.30.0 Draait in src/Modules/Settings/Page.php.

Filtert welke instellingentabs binnen een andere tab staan, als tab-id => id van de gasttab. Weergaven staat standaard in Zichtbaarheid (Toegang). Haal een item weg om een tab weer een eigen plek in de tabbalk te geven. Items waarvan de tab of de gasttab niet bestaat, worden genegeerd, en een gasttab kan zelf niet worden samengevoegd.

Argument	Type	Beschrijving
$merged	array<string, string>	Tab-id => id van de gasttab.

add_filter( 'adba_settings_merged_tabs', function ( $merged ) {
	return $merged;
} );

adba_settings_panel_keys

FilterSinds 2.30.0 Draait in src/Modules/Settings/PrefsTab.php.

Filtert welke instellingen van de tab Uiterlijk in het paneel van een module staan. Koppel een configsleutel van deze tab aan een module-id om hem naar het paneel van die module te verplaatsen (tab Modules, Instellingen), of haal een sleutel weg om hem weer op de tab Uiterlijk te tonen. De opslag verandert niet.

Argument	Type	Beschrijving
$keys	array<string, string>	Configsleutel => module-id.

add_filter( 'adba_settings_panel_keys', function ( $keys ) {
	return $keys;
} );

adba_settings_saved

ActionSinds 1.3.0 Draait in src/Modules/Settings/Page.php.

Vuurt nadat een instellingentab is opgeslagen, vóór de redirect.

Argument	Type	Beschrijving
$tab_id	string	Tab-id, bijvoorbeeld general of modules.
$input	array<string, mixed>	Verzonden waarden (de adba[]-velden, unslashed), elke waarde door sanitize_text_field() gehaald (sinds 2.34.1); de tab saneert zelf per veld.
$done	array<string, mixed>	Wat de tab teruggaf: melding, argumenten en een optionele redirect.

add_action( 'adba_settings_saved', function ( $tab_id, $input, $done ) {
	// ...
}, 10, 3 );

adba_settings_schema

FilterSinds 1.0.0 Draait in src/Modules/Settings/ModulesTab.php.

Filtert het instellingenschema van een module.

Argument	Type	Beschrijving
$schema	array<string, array<string, mixed>>	Velddefinities.
$module_id	string	Module-id.

add_filter( 'adba_settings_schema', function ( $schema, $module_id ) {
	return $schema;
}, 10, 2 );

adba_settings_sections

FilterSinds 2.4.0 Draait in src/Modules/Settings/ModulesTab.php.

Filtert de secties van de tab Modules. Voeg hier een sectie toe en plaats er modules in met adba_settings_card_section. De sectie Overig wordt altijd als laatste toegevoegd.

Argument	Type	Beschrijving
$sections	array<string, string>	Sectie-id => label, in weergavevolgorde.

add_filter( 'adba_settings_sections', function ( $sections ) {
	return $sections;
} );

adba_settings_tabs

FilterSinds 1.3.0 Draait in src/Modules/Settings/Page.php.

Filtert de tabs van de Addofy-instellingenpagina.

Voeg een TabInterface-instantie toe (breid AbstractTab uit) om een tab toe te voegen, herorden de array om tabs te verplaatsen, of gebruik het id van een ingebouwde tab (modules, visibility, menu, preferences, tools) om die te vervangen. Items die geen TabInterface zijn of een id hebben anders dan kleine letters, cijfers, - en _, worden genegeerd. Ingebouwde tabs kunnen niet worden verwijderd. Addofy voegt het submenu-item, de capabilitycontrole en de noncecontrole toe.

Argument	Type	Beschrijving
$tabs	array<string, TabInterface>	Tabs op id, in weergavevolgorde.

add_filter( 'adba_settings_tabs', function ( $tabs ) {
	return $tabs;
} );

adba_setup_links

FilterSinds 1.1.0 Draait in src/Setup/Steps/Done.php.

Filtert de snelkoppelingen op de laatste stap van de quick start.

Argument	Type	Beschrijving
$links	array<int, array{icon: string, title: string, text: string, url: string, module?: string}>	Links op volgorde.

add_filter( 'adba_setup_links', function ( $links ) {
	return $links;
} );

adba_setup_presets

FilterSinds 1.1.0 Draait in src/Setup/ModulePresets.php.

Filtert de modulepresets van de quick start.

Argument	Type	Beschrijving
$presets	array<string, array{label: string, description: string, modules: array<string, bool>}>	Presets op id.
$modules	array<string, ModuleInterface>	Modules die de presets schakelen.

add_filter( 'adba_setup_presets', function ( $presets, $modules ) {
	return $presets;
}, 10, 2 );

adba_setup_steps

FilterSinds 1.1.0 Draait in src/Setup/StepRegistry.php.

Filtert de stappen van de quick start. Voeg een StepInterface toe om een stap toe te voegen; de volgorde blijft behouden.

Argument	Type	Beschrijving
$steps	StepInterface[]	Stappen op volgorde.

add_filter( 'adba_setup_steps', function ( $steps ) {
	return $steps;
} );

adba_setup_woocommerce_cards

FilterSinds 2.36.0 Draait in src/Setup/Steps/WooCommerce.php.

Filtert de modules die de WooCommerce-stap van de quick start schakelt. Voeg het id van je module toe om er in die stap een kaart voor te krijgen; hij verdwijnt dan uit de lijst van de stap Modules.

Argument	Type	Beschrijving
$ids	string[]	Module-id's in de volgorde van weergave.
$modules	array<string, \AddoBack\Modules\ModuleInterface>	Modules die de quick start kan schakelen.

add_filter( 'adba_setup_woocommerce_cards', function ( $ids, $modules ) {
	return $ids;
}, 10, 2 );

adba_user_prefs

FilterSinds 1.3.0 Draait in src/Settings/Prefs.php.

Filtert de gebruikersvoorkeuren die extensies toevoegen, als key => array( 'values' => ..., 'default' => ... ).

De waarde values is 'bool' of een lijst toegestane strings (kleine letters, cijfers, - en _). De sleutel heeft een prefix van je plugin nodig, zoals myplugin_layout; sleutels zonder prefix en de eigen sleutels van Addofy worden genegeerd. Geregistreerde sleutels worden bewaard in de user meta adba_prefs en werken met adba.prefs.get() en adba.prefs.set() in JavaScript.

Argument	Type	Beschrijving
$prefs	array<string, array<string, mixed>>	Voorkeursdefinities op voorkeurssleutel.

add_filter( 'adba_user_prefs', function ( $prefs ) {
	return $prefs;
} );