get_category_parents

(1.2.0以降)
get_category_parents - 親カテゴリー名を含んだカテゴリー名を取得する

説明

mixed get_category_parents( int $id [ , bool $link = false [ , string $separator = '/' [ , bool $nicename = false [ , array $deprecated $visited = array() ] ] ] ] )
親カテゴリー名を含んだカテゴリー名を取得する。

パラメータ

  • $id
    カテゴリーID。
  • $link
    カテゴリー名をリンクで取得する場合はtrue、名前のみの場合はfalseを指定(省略時はfalse)。
  • $separator
    区切り文字(省略時は'/')。
  • $nicename
    カテゴリーのスラッグを取得する場合はtrue、カテゴリー名を取得する場合はfalse(省略時はfalse)。
  • $deprecated $visited
    [4.8.0]廃止閲覧済みのカテゴリーIDの配列(省略時はarray())。

返り値

親カテゴリー名を含んだカテゴリー名を返す。ただし、パラメータ$idが無効なカテゴリーIDの場合は、WP_Errorのオブジェクトを返す。

注意

パラメータ$idで指定したカテゴリーの名前について、親カテゴリーの名前と連結してものを返す。各カテゴリーの名前の後にはそれぞれ区切り文字が連結される(パラメータ$idで指定したカテゴリーの名前にも区切り文字が連結される)。

[4.8.0]第5パラメータが廃止となった。カテゴリーIDが格納された配列が指定された場合は内部で空の配列に変更されるため、これまでと異なる結果となる。

使用例

  • カテゴリーIDが7のカテゴリー名を取得する。
    <?php $cat = get_category_parents( 7 ); ?>
    $catの内容:(親子関係のあるカテゴリーが、それぞれ親(IDが3、スラッグがparent)、子(IDが5、スラッグがchild)、孫(IDが7、スラッグがgrandchild)の場合)
    親/子/孫/
  • カテゴリーIDが7のカテゴリー名(スラッグ)を取得する。
    <?php $cat = get_category_parents( 7, false, '/', true ); ?>
    $catの内容:
    parent/child/grandchild/
  • カテゴリーIDが7のカテゴリー名(リンク付き)を区切り文字>で取得する。
    <?php $cat = get_category_parents( 7, true, ' &gt; ' ); ?>
    $catの内容:(ドメインがlocalhostの場合)
    <a href="http://localhost/?cat=3" title="親 の投稿をすべて表示">親</a> &gt; <a href="http://localhost/?cat=5" title="子 の投稿をすべて表示">子</a> &gt; <a href="http://localhost/?cat=7" title="孫 の投稿をすべて表示">孫</a> &gt;

フィルター

直接実行するフィルターはありません。

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/category-template.php

関連

お勧めコンテンツ

パスとURL(2011年10月6日 登録)

テーマやプラグインで、WordPressシステム関連のディレクトリやURLを使う時があり、それらの多くは関数や定数として定義されている。今回は、それらの関数や定数について整理していく。

ログインページのタイトルを変更してみる(2017年11月17日 登録)

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。

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

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

カスタムフィールドで並び替え(2013年8月9日 登録)

WordPressでは複数の投稿記事を取得する際、並び順の指定を省略すると投稿日時の降順になる。並び順は、投稿日時だけでなく、更新日時、投稿名、記事タイトル、コメント数のほか、カスタムフィールドも指定できる。

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

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

最終更新日時 : 2017-06-10 16:26