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

最終更新 : 2018年05月27日 10:53



お勧め

5.5で非推奨になる関数名について(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

プラグインの設定ページもレスポンシブ対応(2014年6月3日 更新)

レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

全投稿を取得するのはnopaging=1でいい(2011年8月31日 更新)

query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?