概要
get_posts
関数は、指定した条件にマッチする投稿情報を取得するためのWordPressのコア関数です。この関数は、投稿やカスタム投稿タイプ、特定の条件に基づいたフィルタリングなど、多様な用途で使用されます。以下は、get_posts
関数がよく使われる機能です。
- 特定のカテゴリーの投稿を取得
- 最近の投稿をリスト表示
- 記事やページのスライダーを作成
- アーカイブページのカスタマイズ
- 過去の投稿の取得
- タグによるフィルタリング
- カスタムフィールドを使用したフィルタリング
- 特定の著者による投稿を取得
構文
get_posts( $args );
パラメータ
$args
(配列): 投稿を取得するための条件を指定するパラメータ。以下のような項目を設定できます。numberposts
(int): 取得する投稿数category
(int): カテゴリーIDorderby
(string): ソートの順序order
(string): 昇順または降順post_type
(string): 投稿タイプ(例:’post’, ‘page’)
戻り値
array
: 取得した投稿のWP_Postオブジェクトの配列。条件にマッチする投稿がない場合は空の配列が返されます。
関連する関数
使用可能なバージョン
get_posts
関数は、WordPressバージョン 1.5 以降で使用可能です。
コアファイルのパス
wp-includes/post.php
この関数のアクションでの使用可能性
アクション | 使用例 |
---|---|
mu_plugin_loaded | |
registered_post_type | |
plugins_loaded | |
wp_roles_init | |
setup_theme | |
after_setup_theme | |
set_current_user | |
init | |
register_sidebar | |
wp_loaded | |
send_headers | |
parse_query | |
pre_get_posts | 〇 |
wp | 〇 |
template_redirect | |
get_header | |
wp_head |
非推奨または削除されたバージョン
- 現在の時点で、
get_posts
関数は特定のバージョンで非推奨または削除されていません。