rest_default_additional_properties_to_false()


WordPressのrest_default_additional_properties_to_false()関数は、REST APIのレスポンスで追加プロパティをデフォルトで無効にするために使用されます。

構文

rest_default_additional_properties_to_false( array $schema );
  • $schema(array)—REST APIスキーマの配列

例1:基本的な使用法

REST APIのスキーマで追加プロパティを無効にします。

add_filter('rest_default_additional_properties_to_false', '__return_true');

例2:カスタムスキーマでの適用

カスタムエンドポイントのスキーマに適用します。

register_rest_route('myplugin/v1','/data',array('schema'=>array('additionalProperties'=>false)));

例3:投稿タイプのスキーマ変更

投稿タイプのRESTスキーマを変更します。

add_filter('rest_post_collection_params','filter_post_schema');function filter_post_schema($params){$params['additionalProperties']=false;return $params;}

例4:タームスキーマの調整

タームエンドポイントのスキーマを調整します。

add_filter('rest_category_collection_params','filter_term_schema');function filter_term_schema($params){$params['additionalProperties']=false;return $params;}

例5:ユーザーエンドポイントの設定

ユーザーRESTエンドポイントを設定します。

add_filter('rest_user_collection_params','filter_user_schema');function filter_user_schema($params){$params['additionalProperties']=false;return $params;}

例6:メディアエンドポイントの制限

メディアエンドポイントの追加プロパティを制限します。

add_filter('rest_attachment_collection_params','filter_media_schema');function filter_media_schema($params){$params['additionalProperties']=false;return $params;}

例7:カスタムテーブルのスキーマ

カスタムデータベーステーブルのスキーマを定義します。

register_rest_route('custom/v1','/items',array('schema'=>array('properties'=>array('id'=>array('type'=>'integer'),'title'=>array('type'=>'string')),'additionalProperties'=>false)));

注意点

  • この関数はWordPress 5.5以降で利用可能です
  • スキーマを厳密に制御したい場合に使用します
  • 既存のAPIクライアントに影響を与える可能性があります

関連機能：