get_pages

説明

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_of0
parent-1
exclude''
meta_key''
meta_value''
hierarchicalfalse(0)
child_of(省略時は0)
またchild_ofとparentキーワードの違いは、取得する階層にある。child_ofキーワードを指定した場合はそれ以下すべてが対象になるが、parentはその直下のみが対象になる。

使用例

  • 公開されているすべての固定ページを取得する。
    <?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



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。