説明
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
関連
お勧め
Contact Form 7に確認フェーズを(2012年12月16日 更新)
Contact Form 7はWordPressによるサイト製作でお世話になることが多いプラグインの1つ。ただ、クライアント様によっては、入力、確認、送信の3フェーズにしたいという要望があり、そんな時は別の方法を採用していたのですが、JavaScript(jQuery)を使ってページ遷移しなくてもいいなら確認フェーズは用意できるかなと思い、作り込んでみた。投稿一覧に独自リンクを追加する(2013年10月16日 更新)
管理者ページの「投稿一覧」や「固定ページ一覧」の各投稿記事はマウスポインタを移動すると、「編集」や「クイック編集」といったリンクが表示される。このリンクに独自のリンクを追加する方法を調べてみた。HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)
投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。投稿日の検索が自由自在に(2015年3月7日 更新)
WordPress 3.7.0ではWP_Date_Queryクラスが追加され、WP_Queryクラス(もちろん query_posts関数でも)で利用できるようになった。このWP_Date_Queryにより、○年○月○日以前や以降の投稿情報を取得したり、○年○月○日から○年○月○日の範囲の投稿情報を取得したりといったことが、容易に行えるようになった。
プラグインのヘッダー情報を国際化対応しよう(2018年5月27日 更新)
バージョン4.8がリリースされてひと段落。あらためてプラグイン一覧ページを見てみると「Akismet」が「Akismet Anti-Spam (アンチスパム)」と表示されていた。説明文だけじゃなくプラグイン名も国際化対応できたのね。