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



お勧め

初期状態で「抜粋」ウィジェットを表示する(2014年1月7日 更新)

投稿編集ページのウィジェットは標準で表示されるものとされないものがある。フォーラムに『投稿の編集画面にデフォルトで抜粋を表示させたい』という投稿があったので、ちょっと調べてみた。

LevelとCapability(2018年5月27日 更新)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。

管理画面の'アイキャッチ画像'を'写真'に変える(2013年1月23日 更新)

クライアント向けに専用のテーマを提供する際、稀に管理画面内の用語の変更を依頼されることがある。今回は、'アイキャッチ画像'だとわかりにくいので'写真'に変えてほしいということだった。

購読者は管理者ページのアクセス禁止(2013年11月12日 更新)

購読者(subscriber)は、通常「ダッシュボード」「プロフィール」にアクセスできるが、今回はプロフィールを独自に管理する準備を兼ねて、これらのページにアクセスできないようにブロックしてみた。

WordPressのコーディングスタンダードとPSR-2がかみ合わない(2018年5月27日 更新)

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon(4.6)」から「Oxygen(4.7)」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style(Formatter)」が「PSR-2」に設定されていることが原因だった。