• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

関数リファレンス/get post types

提供: WordPress Codex 日本語版
< 関数リファレンス
2014年5月18日 (日) 09:48時点におけるHissy (トーク | 投稿記録)による版 (訳修正、原文リンク修正)

移動先: 案内検索

説明

$wp_post_types から得られる登録された投稿タイプの一覧を返します。

使い方

<?php get_post_types( $args, $output, $operator ) ?>

変数

$args
配列) (オプション) 投稿タイプを絞り込むためのキー・バリュー式の引数の配列。
初期値: array()

次のような引数が使えます:

  • public - 論理値。真である場合、公開された(publicな)投稿タイプのみが返されます。
  • publicly_queryable - 論理値
  • exclude_from_search - 論理値
  • show_ui - Boolean
  • capability_type
  • hierarchical
  • menu_position
  • menu_icon
  • permalink_epmask
  • rewrite
  • query_var
  • _builtin - 論理値。真である場合、WordPressのデフォルトの投稿タイプが返されます。偽である場合、カスタム投稿タイプのみが返されます。'
$output
文字列) (オプション) 返り値の型を指定します。'names'(名前)または'objects'(オブジェクト)。
初期値: 'names'
$operator
文字列) (オプション$argsで複数の条件を指定する場合の演算子(and または od)。
初期値: 'and'

戻り値

配列 
投稿名およびオブジェクトのリスト.

用例

初期値

呼び出し get post types 投稿された投稿タイプを返します。

<?php $post_types = get_post_types(); ?>

全ての投稿タイプのリストを出力

<?php

$post_types = get_post_types( '', 'names' ); 

foreach ( $post_types as $post_type ) {

   echo '<p>' . $post_type . '</p>';
}

?>

全ての公開のカスタム投稿タイプを出力

標準で組み込まれている投稿タイプは、投稿と、固定ページ、添付ファイルです。 '_builtin'falseに設定する事で、カスタム投稿タイプのみを表示します。

<?php

$args = array(
   'public'   => true,
   '_builtin' => false
);

$output = 'names'; // names or objects, note names is the default
$operator = 'and'; // 'and' or 'or'

$post_types = get_post_types( $args, $output, $operator ); 

foreach ( $post_types  as $post_type ) {

   echo '<p>' . $post_type . '</p>';
}

?>

命名された投稿タイプを出力

この例は、'property' として命名された投稿タイプを再取得して出力します。:

uses the 'object' output to retrieve the post type called 'property':

<?php

$args = array(
   'name' => 'property'
);

$output = 'objects'; // names or objects

$post_types = get_post_types( $args, $output );

foreach ( $post_types  as $post_type ) {

   echo '<p>' . $post_type->name . '</p>';
}

?>

register_post_type() 関数を使って登録された"公開"のカスタム投稿タイプを取得する時には気をつけて下さい。 register_post_type 関数に対する入力があまり良い処理のされかたではないため、冗長に publicly_queriable, show_ui, show_in_nav_menus, や exclude_from_searchのオプションを設定したとしても、""public""オプションを設定することに相当するものではなく、公開された投稿タイプの結果を生成するクエリは、期待通りに動作しないでしょう。 参照:bug 18950.

WordPress に組み込まれている投稿タイプ:

  • 投稿
  • 固定ページ
  • 添付ファイル
  • リビジョン
  • nav_menu_item - (Since 3.0)
  • カスタム投稿タイプ - (Since 3.0)

変更履歴

  • 3.0 :
    • Added the operator parameter.
  • Since: 2.9

ソースファイル

get_post_types() is located in wp-includes/post.php.

関連資料

投稿タイプ: register_post_type(), add_post_type_support(), remove_post_type_support(), post_type_supports(), post_type_exists(), set_post_type(), get_post_type(), get_post_types(), get_post_type_object(), get_post_type_capabilities(), get_post_type_labels(), is_post_type_hierarchical(), is_post_type_archive(), post_type_archive_title()

最新英語版: WordPress Codex » Function_Reference/get_post_types最新版との差分


関数リファレンステンプレートタグ目次もご覧ください。