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

関連

お勧めコンテンツ

Login rebuilder:プラグイン作ってみました(2013年1月18日 登録)

昨年投稿した「ログインページを変える」をプラグイン化。ログインページを独自の名前のページ変更し、標準のログインページwp-login.phpを使用できないようにするプラグインです。部外者によるwp-login.phpのアクセスにお悩みの方にお勧めします。また2.0.0では「XML-RPCリクエストの管理機能」を追加しました。

メディアライブラリに絞り込み用の「投稿タグ」を追加する(2014年6月24日 登録)

この記事は、先月投稿したコラム「メディア(attachment)を拡張してより便利に活用する」の続編。メディアで「投稿タグ」を追加するだけで「メディアライブラリ」ページの投稿一覧の中には「タグ」カラムが追加されるが、今回はその「投稿タグ」で絞り込み検索に対応してみる。

タイトルが一致する投稿を検索する(2014年2月20日 登録)

WordPressが提供する投稿ページの文字列検索機能の実現には、query_posts関数(WP_Queryクラス)が大きな役割を担っている。ここで紹介するのは、高機能ゆえに使いこなすのが難しいquery_posts関数(WP_Queryクラス)の使用法の一例である。

add_actionを使って管理ページで独自cssを使う(2011年2月25日 登録)

テーマやプラグインで専用の管理ページを作る場合、そのページ向けのcssやjavascriptが必要になることがある。どちらもページ内に直接記述できるが、特にcssは別ファイルに分けたいほうが便利だ。ここではその方法を紹介しよう。

囲み型ショートコードとwpautop(2014年10月22日 登録)

ショートコードは投稿記事の閲覧時に動的に内容を変更できる優れもの。galleryやcaptionなどいくつかのショートコードが標準で組み込まれており、一部のプラグインではその機能を利用する手段としてショートコードが利用されている。

最終更新日時 : 2015-04-28 10:17