説明
array get_pages( [ mixed $args = '' ] )
固定ページを取得する。
パラメータ
- $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) |
使用例
- 公開されているすべての固定ページを取得する。<?php $pages = get_pages(); ?>
- 文字列で条件を指定して固定ページを取得する。<?php $pages = get_pages( 'number=10' ); ?>
- 連想配列で条件を指定して固定ページを取得する。<?php $pages = get_pages( array( 'number'=>10, 'offset'=>10) ); ?>
フィルター
取得した固定ページ情報を返す直前にget_pagesフィルターが実行される。$pagesには、取得した固定ページ情報の配列が、$rには展開された検索パラメータが格納される。$pages = apply_filters( 'get_pages', $pages, $r );
アクション
実行するアクションはありません。ソースファイル
/wp-includes/post.php最終更新 : 2015年04月28日 10:17
関連
お勧め
5.3の新機能:クエリーログに任意の項目を追加できる新フィルター(2019年10月23日 更新)
「5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。
ログインページのタイトルを変更してみる(2018年5月27日 更新)
バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。
プラグインで注意が必要な関数(2013年11月27日 更新)
先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。
ブロックエディターの色設定を変えてみる(2019年12月11日 更新)
バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。
KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)
本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。