こんにちは、今日はWordPressで投稿一覧を取得する関数、get_postsの使い方についてまとめていきます。
確認環境
WordPress 5.5.1
引数
| キー | 説明 |
| attachment_id | 添付ファイルの投稿ID |
| author | 著者IDをコンマ区切り、または配列で指定します。 |
| author_name | user_nicenameを指定します。 |
| author__in | 著者IDを配列で指定します。 いずれかのIDに一致する投稿が取得できます。 |
| author__not_in | 著者IDを配列で指定します。 いずれのIDにも一致しない投稿が取得できます。 |
| cache_results | 投稿情報をキャッシュするか。 デフォルトはtrue |
| cat | |
| category__and | カテゴリIDの配列を指定します。 全てのカテゴリーが設定されている投稿が取得できます。 |
| category__in | カテゴリIDの配列を指定します。 リスト内のいずれかのカテゴリーが設定されている投稿が取得できます。 |
| category__not_in | カテゴリIDの配列を指定します。 リスト内のいずれのカテゴリーも設定されていない投稿が取得できます。 |
| category_name | カテゴリースラッグ名を指定します。 |
| comment_count | コメント数 |
| comment_status | コメントステータス |
| comments_per_page | 1ページのコメント数 |
| date_query | |
| day | 日 |
| exact | |
| fields | |
| hour | 時 |
| ignore_sticky_posts | Sticky Postsを無視するかどうか |
| m | 月 |
| meta_compare | meta_valueの比較演算子を指定します。 |
| meta_compare_key | meta_keyの比較演算子を指定します。 |
| meta_key | カスタムフィールドのキー |
| meta_query | WP_Meta_Queryの引数の連想配列 |
| meta_value | カスタムフィールドの値 |
| meta_value_num | カスタムフィールドの値 |
| meta_type_key | |
| menu_order | 投稿のメニュー順 |
| monthnum | 2桁の月 |
| name | 投稿スラッグ名 |
| nopaging | ページングをしないかどうか。 デフォルトはfalseでページングします。 |
| no_found_rows | 見つけた合計行数のカウントを行うか。 デフォルトはfalseで、trueにするとパフォーマンスが向上します。 |
| offset | オフセット値。 ページネーション する際に等に使用します。 |
| order | 投稿の昇順、降順を指定します。 ‘ASC’、 ‘DESC’が指定でき、デフォルトは’DESC’です。 |
| orderby | |
| p | 投稿ID |
| page | ページ番号 |
| paged | 現在のページ番号 |
| page_id | ページID |
| pagename | ページスラッグ名 |
| perm | |
| ping_status | Pingステータス |
| post__in | 取得する投稿IDの配列 |
| post__not_in | 取得しない投稿IDの配列 |
| post_mime_type | 投稿のmimeタイプ |
| post_name__in | 投稿スラッグ名の配列を指定します。 |
| post_parent | 親ページID |
| post_parent__in | 親ページIDの配列 |
| post_parent__not_in | 親ページIDの配列 |
| post_type | 投稿タイプのスラッグ名 |
| post_status | 投稿ステータスを文字列、または配列で指定します。 |
| posts_per_page | 1ページに表示する投稿数。 -1を指定すると制限なく取得します。 |
| posts_per_archive_page | |
| s | 検索キーワード |
| second | 秒 |
| sentence | フレーズで検索するか |
| suppress_filters | |
| tag | タグスラッグ名 |
| tag__and | タグIDの配列を指定します。 全てのIDを持つ投稿が取得できます。 |
| tag__in | タグIDの配列を指定します。 いずれかのIDを持つ投稿が取得できます。 |
| tag__not_in | タグIDの配列を指定します。 いずれのIDも持たない投稿が取得できます。 |
| tag_id | タグID、またはIDのコンマ区切りリスト |
| tag_slug__and | タグスラッグ名の配列を指定します。 全ての条件に合致する投稿が取得できます。 |
| tag_slug__in | タグスラッグ名の配列を指定します。 いずれかの条件に合致する投稿が取得できます。 |
| tax_query | WP_Tax_Queryの引数の連想配列 |
| title | 投稿タイトル |
| update_post_meta_cache | |
| update_post_term_cache | |
| lazy_load_term_meta | |
| w | 週の番号を指定します。 0〜53の値が指定可能です。 |
| year | 4桁の年 |
リンク
get_posts() | Function | WordPress Developer Resources
https://developer.wordpress.org/reference/functions/get_posts/
WP_Query::parse_query() | Method | WordPress Developer Resources
https://developer.wordpress.org/reference/classes/WP_Query/parse_query/
