rest_get_allowed_schema_keywords()


WordPressのrest_get_allowed_schema_keywords()関数は、REST APIスキーマで使用可能なキーワードのリストを取得します。JSONスキーマ検証に利用されるキーワードを配列で返します。

構文

rest_get_allowed_schema_keywords();
  • (array) — 許可されたスキーマキーワードの配列

例1: 基本的な使用法

許可されたスキーマキーワードを取得します。

$keywords = rest_get_allowed_schema_keywords();

例2: キーワードの存在確認

特定のキーワードが許可されているか確認します。

if (in_array('type', rest_get_allowed_schema_keywords())) { /* 処理 */ }

例3: カスタムスキーマ検証

REST APIエンドポイントでスキーマ検証を行う例。

register_rest_route('namespace/v1', '/endpoint', array('schema' => array_keys(rest_get_allowed_schema_keywords())));

例4: スキーマキーワードのフィルタリング

許可されたキーワードをフィルタリングします。

add_filter('rest_allowed_schema_keywords', function($keywords) { return $keywords; });

例5: スキーマの動的生成

動的にスキーマを生成する際に使用します。

$schema = array_intersect_key($custom_schema, array_flip(rest_get_allowed_schema_keywords()));

例6: プラグイン開発での利用

プラグインでREST APIスキーマを定義する際に使用。

$plugin_schema = array('title' => 'Plugin', 'type' => 'object') + rest_get_allowed_schema_keywords();

例7: スキーマキーワードの拡張

許可されたキーワードを拡張します。

$extended_keywords = array_merge(rest_get_allowed_schema_keywords(), ['custom_keyword']);

注意点

  • この関数はWordPress 5.3以降で利用可能です
  • 返されるキーワードはWordPressのバージョンによって変更される可能性があります
  • カスタムキーワードを追加する場合はrest_allowed_schema_keywordsフィルタを使用します

関連機能：