プラグインの設定設定ページ、環境変数、wp-config、フックを使ったプラグインの設定
設定ページ、環境変数、wp-config、フックを使ったプラグインの設定
プラグインのオプションを設定する方法はいくつかあります。
設定ページ
設定ページでは、WordPress 管理画面からプラグインを設定できます。
開くには、プラグインのメニューにある「Settings」リンクをクリックします。
設定はタブで整理されており、各タブがモジュールに対応しています。
オプションを更新したら、Save Changes ボタンをクリックして新しい値を保存・適用します。
環境変数と wp-config 定数を使う方法
設定ページのすべてのオプションは、環境変数や wp-config.php ファイルで定義した定数を使って設定することもできます。
オプション値を選択する優先順位は以下のとおりです。
- 対応する環境変数が存在する場合、それが使用されます
wp-config.phpに対応する定数が定義されている場合、それが使用されます- それ以外の場合、設定ページの値が使用されます
環境変数や wp-config 定数を追加または変更した後は、プラグインの設定を再生成する必要があります。そのためには、設定ページに移動して Save Changes をクリックします。
環境変数
| モジュール | オプション | 環境変数 |
|---|---|---|
| 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 定数
wp-config.php ファイルの定数名は環境変数と同じで、先頭に GATOGRAPHQL_ を付けます。
たとえば、環境変数 EDITING_ACCESS_SCHEME は wp-config.php では GATOGRAPHQL_EDITING_ACCESS_SCHEME として定義する必要があります。
フックを使う方法
フックを使ってオプションの値をオーバーライドすることができます。
各オプションは独自のフックをトリガーします。
use PoP\ComponentModel\ComponentConfiguration\ComponentConfigurationHelpers;
$hookName = ComponentConfigurationHelpers::getHookName(
$componentConfigurationClass,
$envVariable
);
add_filter($hookName, 'myFunctionToOverrideSettingsValue', PHP_INT_MAX);フック名を取得するには、以下を指定する必要があります。
$componentConfigurationClass: オプションが定義されているパッケージのComponentConfigurationクラス$envVariable: 設定する環境変数の名前
フックの設定方法についてはこちらの例を参照してください。