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

「テンプレートタグ/get category parents」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(1 版)
(en:Function Reference/get_category_parents 16:42, 29 July 2013 Jdgrimes 版を反映。レイアウト調整。)
 
1行目: 1行目:
* 書式: <?php echo(get_category_parents(category, display link, separator, nice name)); ?>
+
<div id="Description">
* 説明: カテゴリーの親カテゴリーを取得する。
+
== 説明 ==
* 位置: ループ内・外
+
</div>
* 引数:
+
 
** category (整数/$cat)- 親カテゴリーを取得するカテゴリーのID。デフォルト値は「$cat」で、現在表示しているカテゴリーページ/記事のカテゴリーID。
+
指定されたカテゴリーの親カテゴリーのリストを取得します。
** display link (true/false) - 各カテゴリーへのリンクを出力するかどうか。
+
指定されたカテゴリーも含めて、階層の順序で出力します。
*** true(デフォルト。リンクを出力する)
+
 
*** false(デフォルト。リンクを出力しない)
+
<div id="Usage">
** separator (文字列)- リンクの間を区切る記号やテキスト。デフォルト値は「&raquo;」。
+
== 使い方 ==
** nice name (true/false)- カテゴリー・スラッグを名前として使うかどうか。
+
</div>
*** true(デフォルト。英数字小文字のみのカテゴリー・スラッグを出力)
+
 
*** false(デフォルト。大文字や記号、日本語を使ったカテゴリー名を出力)
+
<?php get_category_parents( $id, $link, $separator, $nicename, $visited ); ?>
* コード記述例: <code><nowiki><?php echo(get_category_parents($cat, true, ' &raquo; ')); ?></nowiki></code>
+
 
* 出力例:
+
<div id="Parameters">
 +
== パラメータ ==
 +
</div>
 +
 
 +
{{Parameter|$id|整数|カテゴリー ID}}
 +
 
 +
{{Parameter|$link|真偽値|各カテゴリーへのリンクを出力するか否か。|オプション|<tt>false</tt> - 出力しない}}
 +
 
 +
{{Parameter|$separator|文字列|各カテゴリーを区切る文字列。|オプション|'/'}}
 +
 
 +
{{Parameter|$nicename|真偽値|カテゴリー名の代わりにスラッグを出力するか否か。|オプション|<tt>false</tt> - カテゴリー名を出力}}
 +
 
 +
{{Parameter|$visited|配列|リンク済みカテゴリーの配列。このパラメータは、この関数が自分を再帰的に呼び出すとき、結果のリストにカテゴリーの重複を避けるために使用されます。|オプション|<tt>array()</tt> - 空の配列}}
 +
 
 +
<div id="Return Values">
 +
== 戻り値 ==
 +
</div>
 +
 
 +
; (文字列|WP_Error) : <tt>$separator</tt> で区切られたカテゴリー。失敗した場合は <tt>[[クラスリファレンス/WP_Error | WP_Error]]</tt> を返す。
 +
 
 +
<div id="Example">
 +
== 用例 ==
 +
</div>
 +
 
 +
現在のカテゴリーの親カテゴリーを、リンク付きで '&raquo;' で区切って返します。
 +
 
 +
<pre><?php echo get_category_parents( $cat, true, ' &amp;raquo; ' ); ?></pre>
 +
 
 +
出力例 1 - リンク無し:<br />
 +
Internet &raquo; Blogging &raquo; WordPress &raquo;
 +
 
 +
出力例 2 - リンク付き:<br />
 
<code><nowiki><a href="http://example.com/?cat=2" title="Wordpress の投稿をすべて表示">Wordpress</a> &raquo; <a href="http://example.com/?cat=4" title="Wordpressテーマ の投稿をすべて表示">Wordpressテーマ</a> &raquo; </nowiki></code>
 
<code><nowiki><a href="http://example.com/?cat=2" title="Wordpress の投稿をすべて表示">Wordpress</a> &raquo; <a href="http://example.com/?cat=4" title="Wordpressテーマ の投稿をすべて表示">Wordpressテーマ</a> &raquo; </nowiki></code>
  
[[en:Template Tags/get_category_parents]]
+
<div id="Change Log">
 +
== 変更履歴 ==
 +
</div>
 +
 
 +
* [[Version_1.2|バージョン 1.2.0]] にて導入されました。
 +
 
 +
<div id="Source_File">
 +
== ソースファイル ==
 +
</div>
 +
 
 +
<tt>get_category_parents()</tt> は {{Trac|wp-includes/category-template.php}} にあります。
 +
 
 +
<div id="Related">
 +
== 関連項目 ==
 +
</div>
 +
 
 +
{{Tag Category Tags}}
 +
 
 +
{{Tag Footer}}
 +
 
 +
{{原文|Function Reference/get_category_parents|133735}} <!-- 16:42, 29 July 2013 Jdgrimes 版 -->
 +
 
 +
{{DEFAULTSORT:Get_category_parents}}
 +
[[Category:関数]]
 +
 
 +
[[en:Function Reference/get_category_parents]]

2014年8月9日 (土) 23:52時点における最新版

指定されたカテゴリーの親カテゴリーのリストを取得します。 指定されたカテゴリーも含めて、階層の順序で出力します。

使い方

<?php get_category_parents( $id, $link, $separator, $nicename, $visited ); ?>

パラメータ

$id
整数) (必須) カテゴリー ID
初期値: なし
$link
真偽値) (オプション) 各カテゴリーへのリンクを出力するか否か。
初期値: false - 出力しない
$separator
文字列) (オプション) 各カテゴリーを区切る文字列。
初期値: '/'
$nicename
真偽値) (オプション) カテゴリー名の代わりにスラッグを出力するか否か。
初期値: false - カテゴリー名を出力
$visited
配列) (オプション) リンク済みカテゴリーの配列。このパラメータは、この関数が自分を再帰的に呼び出すとき、結果のリストにカテゴリーの重複を避けるために使用されます。
初期値: array() - 空の配列

戻り値

(文字列|WP_Error) 
$separator で区切られたカテゴリー。失敗した場合は WP_Error を返す。

用例

現在のカテゴリーの親カテゴリーを、リンク付きで '»' で区切って返します。

<?php echo get_category_parents( $cat, true, ' &raquo; ' ); ?>

出力例 1 - リンク無し:
Internet » Blogging » WordPress »

出力例 2 - リンク付き:
<a href="http://example.com/?cat=2" title="Wordpress の投稿をすべて表示">Wordpress</a> » <a href="http://example.com/?cat=4" title="Wordpressテーマ の投稿をすべて表示">Wordpressテーマ</a> »

変更履歴

ソースファイル

get_category_parents()wp-includes/category-template.php にあります。


カテゴリータグ: the_category(), the_category_rss(), single_cat_title(), category_description(), wp_dropdown_categories(), wp_list_categories(), get_the_category(), get_the_category_by_ID(), get_category_by_slug(), get_the_category_list(), get_category_parents(), get_category_link(), is_category(), in_category()


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


最新英語版: WordPress Codex » Function Reference/get_category_parents最新版との差分