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



お勧め

固定ページを投稿ページ用テンプレートファイル(single.php)で表示する(2013年7月31日 更新)

固定ページと投稿ページのデザインが共通の場合、同じ内容のsingle.phpとpage.phpを用意すれば事足りるが、デザインの修正時は二度手間になってしまう。そこで、固定ページをsingle.phpで表示するようにできないか考えてみた。

親子の固定ページで同じテンプレートを使う(2013年3月20日 更新)

固定ページのテンプレートファイルは「page.php」か、ページ名(スラッグ)または投稿IDを指定したテンプレートファイルになる。固定ページでページデザインが数パターンある場合、通常は「page.php」で振り分けることになるが、もう少しスマートにできないか考えてみた。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)

ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。

ログインページのタイトルを変更してみる(2018年5月27日 更新)

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