wp_is_serving_rest_request()


WordPressのwp_is_serving_rest_request()関数は、現在のリクエストがREST APIリクエストであるかどうかを判定するために使用されます。この関数は、REST APIリクエスト中に特定の処理を行いたい場合に便利です。

構文

wp_is_serving_rest_request();
  • bool — 現在のリクエストがREST APIリクエストであればtrue、そうでなければfalseを返します。

例1: REST APIリクエストかどうかを確認する

この例では、現在のリクエストがREST APIリクエストかどうかを確認し、それに応じて処理を行います。

if ( wp_is_serving_rest_request() ) { echo 'これはREST APIリクエストです。'; } else { echo 'これは通常のリクエストです。'; }

例2: REST APIリクエスト中に特定の関数を実行する

REST APIリクエスト中にのみ特定の関数を実行する例です。

if ( wp_is_serving_rest_request() ) { custom_function_for_rest_api(); }

例3: REST APIリクエスト中にCSSを追加する

REST APIリクエスト中に特定のCSSを追加する例です。

if ( wp_is_serving_rest_request() ) { wp_enqueue_style( 'rest-api-style', get_template_directory_uri() . '/rest-api.css' ); }

例4: REST APIリクエスト中にJavaScriptを追加する

REST APIリクエスト中に特定のJavaScriptを追加する例です。

if ( wp_is_serving_rest_request() ) { wp_enqueue_script( 'rest-api-script', get_template_directory_uri() . '/rest-api.js' ); }

例5: REST APIリクエスト中にメタデータを追加する

REST APIリクエスト中にメタデータを追加する例です。

if ( wp_is_serving_rest_request() ) { add_post_meta( get_the_ID(), 'rest_api_meta_key', 'rest_api_meta_value' ); }

例6: REST APIリクエスト中にカスタムフィールドを追加する

REST APIリクエスト中にカスタムフィールドを追加する例です。

if ( wp_is_serving_rest_request() ) { update_post_meta( get_the_ID(), 'custom_field_key', 'custom_field_value' ); }

例7: REST APIリクエスト中にショートコードを実行する

REST APIリクエスト中にショートコードを実行する例です。

if ( wp_is_serving_rest_request() ) { echo do_shortcode( '[custom_shortcode]' ); }

例8: REST APIリクエスト中にカスタムクエリを実行する

REST APIリクエスト中にカスタムクエリを実行する例です。

if ( wp_is_serving_rest_request() ) { $query = new WP_Query( array( 'post_type' => 'post', 'posts_per_page' => 5 ) ); }

注意点

  • この関数は、REST APIリクエスト中にのみ使用することを想定しています。通常のリクエスト中に使用しても意味がありません。
  • REST APIリクエスト中に特定の処理を行う場合、パフォーマンスに影響を与えないように注意してください。

関連機能：