get_pages

（1.5.0以降）
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

関連

参考

Code Reference: get_pages

お勧め

JavaScriptテンプレートを使ってみた（2018年8月21日 更新）

「前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。

子カテゴリのアーカイブページを親カテゴリ用のテンプレートファイルで表示しよう（2011年12月8日 更新）

少し前に投稿した「適切なテンプレートファイルを用意してテンプレート内の振り分け処理を無くす」で説明した通り、特定のカテゴリ専用のテンプレートとしてcategory-○○.phpを用意することで、category.phpやarchive.php内で振り分けを行う必要がなくなる。ただ、すべてのカテゴリ分を用意するのは効率的ではないし、特に子カテゴリについては親カテゴリと共通内容になるケースが多いのではないだろうか。ここでは、子カテゴリの個別テンプレートファイルを作らず、親カテゴリのテンプレートを利用する方法を紹介する。

5.3の新機能：日付とタイムゾーン（2019年10月2日 更新）

「WordPress 5.3 Beta 1」に記載されていた「Time/Date component fixes」という見出し。開発者向として新しい関数の追加や多くのバグが修正されたとなっており、チェックせざるを得ない。

Login rebuilderのログ表示機能を紹介（2018年5月27日 更新）

プラグイン「Login rebuilder」には、バージョン1.2.0からログ情報を保存・確認する機能が備わっています。このログ情報では直近のログインページへの不正アクセスやログイン試行を確認できます。ここでは保存しているログ情報の見方について簡単に説明します。

さくらのVPSでKUSANAGI#3（2018年5月27日 更新）

今回は「前回」の続き。http（80番）をクローズ、そのほかに行った調整作業について整理する。