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



お勧め

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

the_date関数で投稿日を確実に表示する(2011年12月20日 更新)

投稿記事の投稿日時を表示する際、 the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。

WP_Postオブジェクトで投稿情報を直感的に使う(2012年10月4日 更新)

WordPress 3.5で登場するであろう WP_Postクラス。WordPressの投稿情報は、投稿情報本体のほか、カテゴリーや投稿タグ、カスタムフィールドなど、いくつかに分散して記録され、それぞれの情報を取得する際は、いくつかの関数をしていた。新しいWP_Postクラスにより、その習慣とおさらばできるかもしれない。

さくらのVPSでKUSANAGI(2018年5月27日 更新)

請け負っていた業務が一段落したので、「さくらのVPS」で「KUSANAGI」を試してみました。推奨環境はメモリ4GBとなっているが、今回は実験的な利用なので、SSD 2GBプランでトライしました。

絵文字画像がPNGからSVGへ(2018年5月27日 更新)

WordPressでは絵文字に対応していないブラウザ環境で絵文字を表示する仕組みをバージョン4.2から提供。絵文字に対応しているブラウザとそん色がない表示を実現する。