De plugin configureren via de Instellingenpagina, omgevingsvariabelen, wp-config en hooks
Er zijn verschillende manieren om de opties van de plugin te configureren.
De Instellingenpagina
De Instellingenpagina maakt het mogelijk om de plugin te configureren in het WordPress-beheerderspaneel.
Om deze te openen, klik je op de link "Settings" in het menu van de plugin:
De instellingen zijn georganiseerd in tabbladen, waarbij elk tabblad overeenkomt met een module:
Na het bijwerken van een optie klik je op de knop Save Changes om de nieuwe waarde op te slaan en toe te passen.
Via omgevingsvariabelen en wp-config-constanten
Alle opties van de Instellingenpagina kunnen ook worden ingesteld via omgevingsvariabelen en constanten die zijn gedefinieerd in het wp-config.php-bestand.
De prioriteit voor het kiezen van de optiewaarde is als volgt:
- Als de bijbehorende omgevingsvariabele bestaat, wordt deze gebruikt
- Als de bijbehorende constante is gedefinieerd in
wp-config.php, wordt deze gebruikt - Anders wordt de waarde van de Instellingenpagina gebruikt
Na het toevoegen of wijzigen van een omgevingsvariabele of wp-config-constante moet de pluginconfiguratie opnieuw worden gegenereerd. Ga daarvoor naar de Instellingenpagina en klik op Save Changes.
Omgevingsvariabelen
| Module | Optie | Omgevingsvariabele |
|---|---|---|
| Schema Editing Access | Editing Access Scheme | EDITING_ACCESS_SCHEME |
| Single Endpoint | Endpoint Path | GRAPHQL_API_ENDPOINT |
| Custom Endpoints | Endpoint Path | CUSTOM_ENDPOINT_SLUG_BASE |
| Persisted Queries | Endpoint Path | PERSISTED_QUERY_SLUG_BASE |
| Graphiql For Single Endpoint | Client Path | GRAPHIQL_CLIENT_ENDPOINT |
| Interactive Schema For Single Endpoint | Client Path | VOYAGER_CLIENT_ENDPOINT |
| Public Private Schema | Mode | USE_PRIVATE_SCHEMA_MODE |
| Public Private Schema | Enable Granular | ENABLE_INDIVIDUAL_CONTROL_FOR_PUBLIC_PRIVATE_SCHEMA_MODE |
| Schema Namespacing | Use Namespacing | NAMESPACE_TYPES_AND_INTERFACES |
| Nested Mutations | Enable Nested Mutations | ENABLE_NESTED_MUTATIONS |
| Nested Mutations | Disable redundant root type fields | DISABLE_REDUNDANT_ROOT_TYPE_MUTATION_FIELDS |
| Cache Control | Default Max Age | DEFAULT_CACHE_CONTROL_MAX_AGE |
| Schema Posts | List Default Limit | POST_LIST_DEFAULT_LIMIT |
| Schema Posts | List Max Limit | POST_LIST_MAX_LIMIT |
| Schema Posts | Add Type To Custom Post Union Type | ADD_POST_TYPE_TO_CUSTOMPOST_UNION_TYPES |
| Schema Users | List Default Limit | USER_LIST_DEFAULT_LIMIT |
| Schema Users | List Max Limit | USER_LIST_MAX_LIMIT |
| Schema Tags | List Default Limit | TAG_LIST_DEFAULT_LIMIT |
| Schema Tags | List Max Limit | TAG_LIST_MAX_LIMIT |
| Schema Pages | List Default Limit | PAGE_LIST_DEFAULT_LIMIT |
| Schema Pages | List Max Limit | PAGE_LIST_MAX_LIMIT |
| Schema Pages | Add Type To Custom Post Union Type | ADD_PAGE_TYPE_TO_CUSTOMPOST_UNION_TYPES |
| Schema Custom Posts | List Default Limit | CUSTOMPOST_LIST_DEFAULT_LIMIT |
| Schema Custom Posts | List Max Limit | CUSTOMPOST_LIST_MAX_LIMIT |
| Schema Custom Posts | Use Single Type Instead Of Union Type | USE_SINGLE_TYPE_INSTEAD_OF_CUSTOMPOST_UNION_TYPE |
wp-config-constanten
De naam van de constante in het wp-config.php-bestand is hetzelfde als de omgevingsvariabele, met het voorvoegsel GATOGRAPHQL_.
Omgevingsvariabele EDITING_ACCESS_SCHEME moet bijvoorbeeld worden gedefinieerd als GATOGRAPHQL_EDITING_ACCESS_SCHEME in wp-config.php.
Via hooks
Je kunt de waarde van een optie overschrijven via een hook.
Elke optie activeert zijn eigen hook:
use PoP\ComponentModel\ComponentConfiguration\ComponentConfigurationHelpers;
$hookName = ComponentConfigurationHelpers::getHookName(
$componentConfigurationClass,
$envVariable
);
add_filter($hookName, 'myFunctionToOverrideSettingsValue', PHP_INT_MAX);Om de hooknaam te verkrijgen, moeten we het volgende opgeven:
$componentConfigurationClass: DeComponentConfiguration-klasse uit het pakket waar de optie is gedefinieerd$envVariable: De naam van de in te stellen omgevingsvariabele
Bekijk een voorbeeld van het instellen van een hook.