当サイト、Codex 日本語版は今後積極的な更新は行わない予定です。後継となる新ユーザーマニュアルは、https://ja.wordpress.org/support/ にあります。
万が一、当サイトで重大な問題を発見した際などは、フォーラムWordSlack #docs チャンネルでお知らせください。</p>

「関数リファレンス/get post types」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(Change Log)
(訳修正、原文リンク修正)
1行目: 1行目:
{{Languages|
 
{{en|Function Reference/get_post_types}}
 
{{it|Riferimento_funzioni/get_post_types}}
 
}}
 
 
 
== 説明 ==
 
== 説明 ==
  
''$wp_post_types''に存在するのと同様に [[Function_Reference/register_post_type|registered post types]] を返します。
+
''$wp_post_types'' から得られる[[関数リファレンス/register_post_type|登録された投稿タイプの一覧]]を返します。
  
 
== 使い方 ==
 
== 使い方 ==
14行目: 9行目:
 
== 変数 ==
 
== 変数 ==
  
{{Parameter|$args|array|An array of key value arguments to match against the post types.|optional|<tt>array()</tt>}}
+
{{Parameter|$args|配列|投稿タイプを絞り込むためのキー・バリュー式の引数の配列。|オプション|<tt>array()</tt>}}
Some of these include:
+
次のような引数が使えます:
* public - ''Boolean. If true, only public post types will be returned.''
+
* public - ''論理値。真である場合、公開された(publicな)投稿タイプのみが返されます。''
* publicly_queryable - ''Boolean''
+
* publicly_queryable - ''論理値''
* exclude_from_search - ''Boolean''
+
* exclude_from_search - ''論理値''
 
* show_ui - ''Boolean''
 
* show_ui - ''Boolean''
 
* capability_type
 
* capability_type
27行目: 22行目:
 
* rewrite
 
* rewrite
 
* query_var
 
* query_var
* _builtin - ''Boolean. If <tt>true</tt>, will return WordPress default post types. Use <tt>false</tt> to return only custom post types.''  
+
* _builtin - ''論理値。真である場合、WordPressのデフォルトの投稿タイプが返されます。偽である場合、カスタム投稿タイプのみが返されます。'  
  
{{Parameter|$output|string|The type of output to return, either <tt>'names'</tt> or <tt>'objects'</tt>.|optional|<tt>'names'</tt>}}
+
{{Parameter|$output|文字列|返り値の型を指定します。<tt>'names'</tt>(名前)または<tt>'objects'</tt>(オブジェクト)。|オプション|<tt>'names'</tt>}}
  
{{Parameter|$operator|string|Operator (and/or) to use with multiple <tt>$args</tt>.|optional|<tt>'and'</tt>}}
+
{{Parameter|$operator|文字列|<tt>$args</tt>で複数の条件を指定する場合の演算子(and または od)。|オプション|<tt>'and'</tt>}}
  
 
== 戻り値 ==
 
== 戻り値 ==
61行目: 56行目:
 
=== 全ての公開のカスタム投稿タイプを出力 ===
 
=== 全ての公開のカスタム投稿タイプを出力 ===
  
標準で組み込まれている投稿タイプは、投稿と、固定ページ、添付ファイルです。 <tt>'_builtin'</tt> を<tt></tt>に設定する事で、カスタム投稿タイプのみを表示します。
+
標準で組み込まれている投稿タイプは、投稿と、固定ページ、添付ファイルです。 <tt>'_builtin'</tt> を<tt>false</tt>に設定する事で、カスタム投稿タイプのみを表示します。
  
 
<pre>
 
<pre>
86行目: 81行目:
 
=== 命名された投稿タイプを出力 ===
 
=== 命名された投稿タイプを出力 ===
  
この例は、<tt>'property'</tt> として命名された投稿タイプを再取得してアウトプットします。:
+
この例は、<tt>'property'</tt> として命名された投稿タイプを再取得して出力します。:
  
 
uses the <tt>'object'</tt> output to retrieve the post type called <tt>'property'</tt>:
 
uses the <tt>'object'</tt> output to retrieve the post type called <tt>'property'</tt>:
111行目: 106行目:
 
== 注 ==
 
== 注 ==
  
[http://codex.wordpress.org/Function_Reference/register_post_type register_post_type()] 関数を使って登録された"公開"のカスタム投稿タイプを再取得する時には気をつけて下さい。
+
[http://codex.wordpress.org/Function_Reference/register_post_type register_post_type()] 関数を使って登録された"公開"のカスタム投稿タイプを取得する時には気をつけて下さい。
register_post_type 関数の入力は懸命ではありません。もし冗長な'''publicly_queriable''', '''show_ui''', '''show_in_nav_menus''', や '''exclude_from_search'''のオプションを設定するならば、
+
register_post_type 関数に対する入力があまり良い処理のされかたではないため、冗長に '''publicly_queriable''', '''show_ui''', '''show_in_nav_menus''', や '''exclude_from_search'''のオプションを設定したとしても、""public""オプションを設定することに相当するものではなく、公開された投稿タイプの結果を生成するクエリは、期待通りに動作しないでしょう。
公開オプションを設定するに相当するものではありません。また、公開投稿タイプのクエリが、明確な引数で定義された結果を生成します。
+
 
参照:[http://core.trac.wordpress.org/ticket/18950 bug 18950].
 
参照:[http://core.trac.wordpress.org/ticket/18950 bug 18950].
  
136行目: 130行目:
 
== 関連資料 ==
 
== 関連資料 ==
 
{{Post Type Tags}}
 
{{Post Type Tags}}
 +
{{原文|Function_Reference/get_post_types|138674}}<!-- 14:20, 30 November 2013 Mistercat  -->
  
 
{{Tag Footer}}
 
{{Tag Footer}}
{{原文|Function Reference/get post type|71794}}<!-- 14:20, 30 November  2013 Mistercat  -->
 
 
[[Category:Functions]]
 
[[Category:Functions]]
[[en:Function Reference/get post type]]
 

2014年5月18日 (日) 09:48時点における版

説明

$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最新版との差分


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