説明
パラメータ
- $args検索条件を文字列または連想配列で指定(省略時は'')。主なキーワードは次の通り。
キーワード 意味 child_of 子孫のページを取得するための親固定ページのID(省略時は0) sort_order 並び順として'ASC'か'DESC'を指定(省略時は'ASC')。 sort_column ソート対象として'ID'、'post_title'、'menu_order'などのカラム名か'rand'、'comment_count'を指定(省略時は'post_title') hierarchical 下階層を取得する場合は1、しない場合は0を指定(省略時は1) exclude 除外する固定ページのID(省略時はarray()) include 取得する固定ページのID(省略時はarray()) meta_key カスタムフィールドの名前(省略時は'') meta_value カスタムフィールドの値(省略時は'') authors 投稿者ID。複数指定する場合は空白文字かカンマで区切る(省略時は'') parent 親の固定ページのID(省略時は-1) exclude_tree 除外する親固定ページのID(省略時は'') number 取得件数(省略時は'') offset 取得位置を示すオフセット(省略時は0) post_type 投稿情報タイプ(省略時は'page') post_status 投稿ステータスを示す'auto-draft'、'draft'、'inherit'、'private'、'publish'、'any'など(省略時は'publish')
返り値
パラメータ$argsで指定された条件にマッチする固定ページ情報を配列で返す。マッチする固定ページがない場合は空の配列となる。固定ページ情報の内容は投稿情報と同じ(詳しくは $postを参照)。注意
投稿ページを取得する get_posts関数の固定ページ版的な位置づけの関数で、検索条件のパラメータは多少異なっている。
includeパラメータを指定した場合は、以下のパラメータは強制的に書き換えられる。
キーワード | 書き換えられる値 |
---|---|
child_of | 0 |
parent | -1 |
exclude | '' |
meta_key | '' |
meta_value | '' |
hierarchical | false(0) |
child_of | (省略時は0) |
またchild_ofとparentキーワードの違いは、取得する階層にある。child_ofキーワードを指定した場合はそれ以下すべてが対象になるが、parentはその直下のみが対象になる。
[6.3.0]'get_pages_query_args'フィルターが追加された。
使用例
- 公開されているすべての固定ページを取得する。<?php $pages = get_pages(); ?>
- 文字列で条件を指定して固定ページを取得する。<?php $pages = get_pages( 'number=10' ); ?>
- 連想配列で条件を指定して固定ページを取得する。<?php $pages = get_pages( array( 'number'=>10, 'offset'=>10) ); ?>
フィルター
[6.3.0]クエリーを実行する前に'get_pages_query_args'フィルターを呼び出す。パラメータ$query_argsには検索パラメータの連想配列が、$parsed_argsには展開された検索パラメータの連想配列が格納される。$query_args = apply_filters( 'get_pages_query_args', $query_args, $parsed_args );
return apply_filters( 'get_pages', $pages, $parsed_args );
アクション
実行するアクションはありません。ソースファイル
/wp-includes/post.php最終更新 : 2023年08月10日 15:28
関連
お勧め
自動生成される抜粋からテーブルブロックの内容を除外する(2022年4月6日 更新)
標準テーマである「Twenty Twenty-Two」や「Twenty Twenty-One」では、トップページやアーカイブページにおいて投稿情報を表示する際、その抜粋を使っている。とある投稿にテーブルブロックを入れた際、トップページに表示された抜粋には各セルの内容が列挙され、ちょっとモヤモヤした。
Post-tag automaton:プラグイン作ってみました(2012年12月24日 更新)
みなさんは投稿をポストする際に投稿タグを付け忘れたことはないでしょうか。このプラグインは、投稿をポストする際にタイトルと記事に投稿タグが含まれていないか調べ、含まれていた場合はその投稿タグを追加します。ダッシュボードのフィードボックスをカスタマイズ(2011年7月8日 更新)
管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する(管理者権限)。投稿一覧に「投稿フォーマット」フィルターが追加される(2019年4月12日 更新)
WordPress 5.2 Beta2(以降5.2Beta2)のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」(select要素)が追加されていた。
さくらのVPSでKUSANAGI#2(2018年5月27日 更新)
今回は「前回」の続き。さくらのVPS(メモリー2GB SSDプラン)でパフォーマンスをApacheのabコマンドで確認してみた。はてさて、うたい文句通りのパフォーマンスは発揮するのだろうか。