説明
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
関連
お勧め
ダッシュボードの「クイックドラフト」を「CodeMirror」に変更してみた(2019年11月5日 更新)
管理ページの「テーマエディター」では4.9以降「CodeMirror」が利用されている。今回はこの「CodeMirror」をプラグインで活用できないか調べた話である。
headタグのmeta(generator)タグを取り除く(2018年5月27日 更新)
標準的なWordPressのテーマで出力されるHTMLには、headタグ内に次のようなmetaタグが出力されている。<meta name="generator" content="WordPress 3.0.5" />
Blacklist keys manager:プラグイン作ってみました(2015年5月22日 更新)
少し前から明らかにスパムと思われるコメントが投稿され、そのモデレーションメールを受け取る回数が増えてきた。あまりにもあからさまなコメントばかりなので、何らかの対策ができないか考えてみました。
5.5の機能強化:テーマ変更時に要求バージョンを確認(2020年8月12日 更新)
WordPress 5.5 RC 2が公開され、来週には正式版がリリース。変更箇所が多い「WordPress 5.5 RC 2(以降RC 2)」のソースコードを眺めていると、テーマの切り替え前にWordPressとPHPのバージョンを確認するようになっていた。
投稿内容に応じてwpautopを制御する(2013年8月13日 更新)
投稿内容を表示する the_content関数では、 wpautop関数がフィルターの1つとして呼び出され、改行をbrタグに変換したり、pタグで調整したりする。この機能自体は便利なのだが、きちんとデザインされたHTMLソースを流し込んだ場合はこの機能は好ましくない。そんなわけで、記事内容に応じてwpautop関数を制御できないか考えてみた。