Das Plugin konfigurieren
Das Plugin konfigurierenDas Plugin über die Einstellungsseite, Umgebungsvariablen, wp-config und Hooks konfigurieren

Das Plugin über die Einstellungsseite, Umgebungsvariablen, wp-config und Hooks konfigurieren

Es gibt verschiedene Möglichkeiten, die Optionen des Plugins zu konfigurieren.

Die Einstellungsseite

Die Einstellungsseite ermöglicht es, das Plugin in der WordPress-Administration zu konfigurieren.

Um sie zu öffnen, klicke auf den Link „Settings" im Menü des Plugins:

Öffnen der Einstellungsseite

Die Einstellungen sind in Tabs organisiert, wobei jeder Tab einem Modul entspricht:

Einstellungsseite

Nachdem du eine Option aktualisiert hast, klicke auf die Schaltfläche Save Changes, um den neuen Wert zu speichern und anzuwenden.

Über Umgebungsvariablen und wp-config-Konstanten

Alle Optionen der Einstellungsseite können auch über Umgebungsvariablen und Konstanten gesetzt werden, die in der Datei wp-config.php definiert sind.

Die Priorität bei der Auswahl des Optionswerts ist folgende:

  1. Wenn die entsprechende Umgebungsvariable vorhanden ist, wird sie verwendet
  2. Wenn die entsprechende Konstante in wp-config.php definiert ist, wird sie verwendet
  3. Andernfalls wird der Wert von der Einstellungsseite verwendet

Nach dem Hinzufügen oder Ändern einer Umgebungsvariablen oder wp-config-Konstante muss die Plugin-Konfiguration neu generiert werden. Gehe dazu zur Einstellungsseite und klicke auf Save Changes.

Umgebungsvariablen

ModulOptionUmgebungsvariable
Schema Editing AccessEditing Access SchemeEDITING_ACCESS_SCHEME
Single EndpointEndpoint PathGRAPHQL_API_ENDPOINT
Custom EndpointsEndpoint PathCUSTOM_ENDPOINT_SLUG_BASE
Persisted QueriesEndpoint PathPERSISTED_QUERY_SLUG_BASE
Graphiql For Single EndpointClient PathGRAPHIQL_CLIENT_ENDPOINT
Interactive Schema For Single EndpointClient PathVOYAGER_CLIENT_ENDPOINT
Public Private SchemaModeUSE_PRIVATE_SCHEMA_MODE
Public Private SchemaEnable GranularENABLE_INDIVIDUAL_CONTROL_FOR_PUBLIC_PRIVATE_SCHEMA_MODE
Schema NamespacingUse NamespacingNAMESPACE_TYPES_AND_INTERFACES
Nested MutationsEnable Nested MutationsENABLE_NESTED_MUTATIONS
Nested MutationsDisable redundant root type fieldsDISABLE_REDUNDANT_ROOT_TYPE_MUTATION_FIELDS
Cache ControlDefault Max AgeDEFAULT_CACHE_CONTROL_MAX_AGE
Schema PostsList Default LimitPOST_LIST_DEFAULT_LIMIT
Schema PostsList Max LimitPOST_LIST_MAX_LIMIT
Schema PostsAdd Type To Custom Post Union TypeADD_POST_TYPE_TO_CUSTOMPOST_UNION_TYPES
Schema UsersList Default LimitUSER_LIST_DEFAULT_LIMIT
Schema UsersList Max LimitUSER_LIST_MAX_LIMIT
Schema TagsList Default LimitTAG_LIST_DEFAULT_LIMIT
Schema TagsList Max LimitTAG_LIST_MAX_LIMIT
Schema PagesList Default LimitPAGE_LIST_DEFAULT_LIMIT
Schema PagesList Max LimitPAGE_LIST_MAX_LIMIT
Schema PagesAdd Type To Custom Post Union TypeADD_PAGE_TYPE_TO_CUSTOMPOST_UNION_TYPES
Schema Custom PostsList Default LimitCUSTOMPOST_LIST_DEFAULT_LIMIT
Schema Custom PostsList Max LimitCUSTOMPOST_LIST_MAX_LIMIT
Schema Custom PostsUse Single Type Instead Of Union TypeUSE_SINGLE_TYPE_INSTEAD_OF_CUSTOMPOST_UNION_TYPE

wp-config-Konstanten

Der Name der Konstante in der Datei wp-config.php ist identisch mit dem der Umgebungsvariablen, wobei GATOGRAPHQL_ vorangestellt wird.

Zum Beispiel muss die Umgebungsvariable EDITING_ACCESS_SCHEME in wp-config.php als GATOGRAPHQL_EDITING_ACCESS_SCHEME definiert werden.

Über Hooks

Wir können den Wert einer Option über einen Hook überschreiben.

Jede Option löst ihren eigenen Hook aus:

use PoP\ComponentModel\ComponentConfiguration\ComponentConfigurationHelpers;
 
$hookName = ComponentConfigurationHelpers::getHookName(
    $componentConfigurationClass,
    $envVariable
);
add_filter($hookName, 'myFunctionToOverrideSettingsValue', PHP_INT_MAX);

Um den Hook-Namen zu erhalten, müssen wir angeben:

  • $componentConfigurationClass: Die ComponentConfiguration-Klasse des Pakets, in dem die Option definiert ist
  • $envVariable: Der Name der zu setzenden Umgebungsvariablen

Sieh dir ein Beispiel für das Setzen eines Hooks an.