まずはアクションフックの設定

rest_prepare_postのアクションフックを追加します。

add_action('rest_prepare_post', 'remove_post_links', 10, 3);

コールバック(削除の際に使用する関数)は「remove_post_links」としました。 ここは好きに決めて大丈夫です。

rest_prepare_postの引数

公式の説明によると、引数は3つ。

• 第1引数：
  WP_REST_Responseオブジェクトで、今回削除する「_links」はここに入っています
• 第2引数：
  WP_Postオブジェクトで、よく使う記事情報です
• 第3引数：
  WP_REST_Requestオブジェクトで、GETのパラメータなどが入っていました

コールバック関数の追加

コールバック関数の基本はこの↓ような形になります。

function remove_post_links($response, $post, $request) {
  
  return $response;
}

WP_REST_Responseである「$response」に削除対象があるので、$responseを操作した後、それを返します。

削除したい「_links」は「$response」の中の「links」というプロパティの中に入っていますが、「protected」に設定されているためそのままではアクセスできません。

ですがWP_REST_Responseには「links」の中身を操作する関数が用意されているので、今回は削除用の「remove_link」を使います。

function remove_post_links($response, $post, $request) {
  $response->remove_link('self');
  $response->remove_link('collection');
  $response->remove_link('about');
  $response->remove_link('author');
  $response->remove_link('replies');
  $response->remove_link('version-history');
  $response->remove_link('wp:attachment');
  $response->remove_link('wp:term');
  $response->remove_link('curies');
  
  return $response;
}

何を削除するのかあらかじめ把握できていたので、全部のキーを削除指定にしてみました(不細工)。

出力結果↓。

"_links": {
  "wp:attachment": [
    {
      "href": "https://dev.ore-shika.com/wp-json/wp/v2/media?parent=102"
    }
  ],
  "wp:term": [
    {
      "taxonomy": "category",
      "embeddable": true,
      "href": "https://dev.ore-shika.com/wp-json/wp/v2/categories?post=102"
    },
    {
      "taxonomy": "post_tag",
      "embeddable": true,
      "href": "https://dev.ore-shika.com/wp-json/wp/v2/tags?post=102"
    }
  ],
  "curies": [
    {
      "name": "wp",
      "href": "https://api.w.org/{rel}",
      "templated": true
    }
  ]
}

「wp:attachment」「wp:term」「curies」の3つが消えてません。

「wp:」から始まる2つは名前が特徴的なのと、「curies」は明らかに内容が異質なので、何か別の指定が必要なのかもしれません。

get_links()で全キー取得して根こそぎ削除

WP_REST_Responseにはlinksに含まれる要素を全て取得する関数「get_links()」が用意されていました。

全要素を取得して、foreachで根こそぎ削除してみます。

function remove_post_links($response, $post, $request) {
  $links = $response->get_links();
  
  foreach ( $links as $key => $value) {
    $response->remove_link($key);
  }
  
  return $response;
}

これで無事に全要素を削除することができました。

というか、中身が空になったせいで「_links」自体が消えてますね。

ついでに、上記ループで$keyを確認したところ、「wp:attachment」は「https://api.w.org/attachment」、「wp:term」は「https://api.w.org/term」になっていました。

「curies」は見つかりませんでしたが、「_linksがひとつでも要素を持っていたら自動で追加」とかそんな感じなのかな。

「content」を上書きしてみた

この方法は「context=embed」を知らなかった時に「content」(記事本文)を削除してやろうと考えていた方法なので「content」で試してみます。

add_action( 'rest_api_init', 'api_add_fields' );
function api_add_fields() {
  register_rest_field( 'post',
    'content',
     array(
      'get_callback'    => 'register_fields',
      'update_callback' => null,
      'schema'          => null,
    )
  );
}
function register_fields( $post, $name ) {
  return null;
}

追加するAPIのキーに既存の「content」を指定し、コールバック関数でnullを返します。

出力結果↓。

"content": null,

無事に既存キーの内容を上書きできました。

「_links」も上書きできるのか？

同様に、キーを「_links」にして上書きしてみます。

add_action( 'rest_api_init', 'api_add_fields' );
function api_add_fields() {
  register_rest_field( 'post',
    '_links',
     array(
      'get_callback'    => 'register_fields',
      'update_callback' => null,
      'schema'          => null,
    )
  );
}
function register_fields( $post, $name ) {
  return null;
}

出力結果↓。

"_links": {
  "self": [
    (略)

上書きできていませんでした。

試しにアンダースコアのない「links」も試しましたがダメです。

この方法では「_links」を削除できないもよう。