指定できる最小値と最大値

「1」から「100」までです。

{
  "code": "rest_invalid_param",
  "message": "無効なパラメーター: per_page",
  "data": {
    "status": 400,
    "params": {
      "per_page": "per_page は1以上、100以下でなければなりません。"
    }
  }
}

全件取得する方法は？

REST API側にそういう機能はなさそうです。

世には記事1万越えのサイトとかもあるので当然と言えば当然でしょう。

どうしても全件取得したい場合は、100件ごとに取得し、次の「page」オプションと合わせて、レスポンスがなくなるまで何度も取得する、という方法くらいしかないんじゃないでしょうか。

指定できる最小値と最大値

「1」以上のようで、特に上限はなさそう。

それ以外(「0」など)を指定するとエラーがでます。

{
  "code": "rest_invalid_param",
  "message": "無効なパラメーター: page",
  "data": {
    "status": 400,
    "params": {
      "page": "page は1以上である必要があります"
    }
  }
}

記事数を超えるページを指定するとどうなるか

空の配列ではなくエラーが返ります。

{
  "code": "rest_post_invalid_page_number",
  "message": "リクエストされたページ数は存在するページ数を上回っています。",
  "data": {
    "status": 400
  }
}

日本語は使える？

使えました。

/wp/v2/posts?search=引数

テスト環境ではURLエンコードしなくても動いていますが、一応しておいた方がよさそう。

複数指定はできる？

できました。

/wp/v2/posts?search=引数+Nuxt

キーワードの連結は「＋」でも半角スペースでもできました。 全角スペースはダメです。 文字として認識されています。

こちらも環境によりそうなので、「＋」で連結しておいた方が安全そう。

複数指定の場合はAND検索？

AND検索でした。

OR検索はどうやるんだろ。 マニュアルがあっさりし過ぎてて分からないです。

該当記事がひとつも見つからなかった場合は？

空の配列が返りました。

[]

タイムゾーン指定なしで日本時間になるのか？

なりました。

おそらく単純に「date」と「after」の値を比較しているだけです。

「date」が日本時間なら日本時間で検索されます。

日時指定に問題があるとどうなるのか？

エラーが出ます。

{
  "code": "rest_invalid_param",
  "message": "無効なパラメーター: after",
  "data": {
    "status": 400,
    "params": {
      "after": "無効な日時です。"
    }
  }
}

該当記事がなかった場合はどうなるのか？

空の配列が返ります。

[]

未来の日付を指定するとどうなるのか？

「該当なし」と同じ扱いなのか、空の配列が返ります。

[]

複数の著者を指定する方法

「author=1+2」のように、ユーザIDを「＋」で連結します。

著者をスラッグで指定できるか？

できませんでした。

{
  "code": "rest_invalid_param",
  "message": "無効なパラメーター: author",
  "data": {
    "status": 400,
    "params": {
      "author": "author[0] は integer タイプではありません。"
    }
  }
}

どうしてもスラッグで検索したい場合は、先にユーザのAPIをスラッグで検索してユーザ情報を取得し、そのIDで再検索する形になるでしょう。

存在しないユーザIDを指定した場合は？

空の配列が返ります。

[]

複数の記事を指定する方法

「exclude=1+2」のように、記事IDを「＋」で連結します。

記事をスラッグで指定できるか？

できませんでした。

{
  "code": "rest_invalid_param",
  "message": "無効なパラメーター: exclude",
  "data": {
    "status": 400,
    "params": {
      "exclude": "exclude[0] は integer タイプではありません。"
    }
  }
}

どうしてもスラッグで検索したい場合は、先に記事APIからスラッグで記事を検索して、そのIDで再検索する形になるでしょう。

複数の記事を指定する方法

「include=1+2」のように、記事IDを「＋」で連結します。

これ何に使うの？

単体の記事が欲しいなら「/wp/v2/posts/(ID)」で取得できます。

ID指定で複数の記事が欲しい時…？

例えばですね、「著者Aで絞り込んで、著者Bのこの記事だけ追加してほしい」みたいなケースでは使えるかと思ったんですが、実行してみると「著者Aかつ指定IDの記事」となっているみたいで空の配列が返ってきました。

指定できる最大値と最小値

たぶん整数なら全て指定できます。

ただし、マイナスの場合はマイナスが無視されます。 「-5」を指定すると「5」と解釈されていました。

整数以外の小数や文字を指定するとエラーが出ます。

{
  "code": "rest_invalid_param",
  "message": "無効なパラメーター: offset",
  "data": {
    "status": 400,
    "params": {
      "offset": "offset は integer タイプではありません。"
    }
  }
}

orderbyで指定できるキーの種類

指定できるキーは次の10種類です。

• 「author」：
  記事の著者IDでソート
• 「date」：
  記事の効果日時でソート(デフォルト)
• 「id」：
  記事IDでソート
• 「include」：
  「include」オプションで指定した順にソート
  「include」を指定しないとエラーが出ます
• 「modified」：
  更新日時でソート
• 「parent」：
  親ページIDでソート
• 「relevance」：
  「search」で指定したキーワードとの関連性でソート
  「search」を指定しないとエラーが出ます
• 「slug」：
  記事のスラッグでソート
• 「include_slugs」：
  分かりませんでした。「orderby=id&order=asc」の結果と一致しています。なんだこれ。
• 「title」：
  記事のタイトルでソート

これ以外を指定するとエラーが出ます。

{
  "code": "rest_invalid_param",
  "message": "無効なパラメーター: orderby",
  "data": {
    "status": 400,
    "params": {
      "orderby": "orderby は author, date, id, include, modified, parent, relevance, slug, include_slugs, title, menu_order に当てはまりません。"
    }
  }
}

カスタムフィールドでソートはできない？

できます。

add_action('rest_post_query', 'sortby_meta_key', 10, 2);
function sortby_meta_key($args, $request) {
  if ( isset($request['meta_key']) ) {
    $args['meta_key'] = $request['meta_key'];
    $args['orderby'] = 'meta_value_num';
    
    if ( isset($request['meta_orderby']) ) {
      $args['orderby'] = $request['meta_orderby'];
    }
  }
  return $args;
}

使い方や注意点はカスタムフィールドでソートの記事を見てください。

注意！結果は配列で返る

スラッグは一見一意(ユニーク)っぽいですが、階層が違うと同じスラッグを指定できます。

この可能性があるため結果は配列で返ります。

詳しくはスラッグで取得する記事を見てください。

部分一致で検索できる？

残念ながらできないようです。

完全一致検索。

スラッグの複数指定はできる？

できました。

スラッグ文字列を「＋」で連結するだけです。

存在しないスラッグを指定した場合は？

空の配列が返ります。

[]

複数のカテゴリを指定する方法

「categories=8+14」のように、カテゴリIDを「＋」で連結します。

カテゴリをスラッグで指定できるか？

できませんでした。

{
  "code": "rest_invalid_param",
  "message": "無効なパラメーター: categories",
  "data": {
    "status": 400,
    "params": {
      "categories": "categories[0] は integer タイプではありません。"
    }
  }
}

どうしてもスラッグで検索したい場合は、先にカテゴリのAPIをスラッグで検索してカテゴリ情報を取得し、そのIDで再検索する形になるでしょう。

存在しないカテゴリIDを指定した場合は？

空の配列が返ります。

[]

「sticky」を数字で指定

「sticky=0」で「この投稿を先頭に固定表示」がオフのものを、「sticky=1」で「この投稿を先頭に固定表示」がオンのものを表示します。

「sticky」を真偽値で指定

「sticky=false」で「この投稿を先頭に固定表示」がオフのものを、「sticky=true」で「この投稿を先頭に固定表示」がオンのものを表示します。