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



お勧め

カスタムフィールド関連関数のおさらい(2012年6月22日 更新)

カスタムフィールドは、投稿記事の拡張情報としてよく利用されている。投稿ページで登録した情報をアーカイブや投稿ページで表示しているが、投稿ページを表示する際にカスタムフィールドの値を更新して、サイドバーのようなページ内要素に利用したりしている。

MOファイルを作ってみた(2018年7月25日 更新)

テーマやプラグインで使用するMOファイルはWindows環境では「Poedit」アプリを使うことが多かったが、最近では「GlotPress」のようなプラグインも増えてきており、選択肢は広がっている。定期的に開発環境を見直す過程で「Poedit」から「GlotPress」に切り替えようと思ったのだが、微妙にしっくりこなかった。

日本語名のユーザーを登録する(2018年5月27日 更新)

標準のログインID(ユーザー名)は、英数字と一部の記号の組み合わせで構成されている。一般的なシステムのログインIDはおおむねこんな感じだが、ふと「インターネット環境ならログインIDに日本語が使用できてもいいんじゃないか」と思い、実現できるか調べてみた。

ショートコードを使ってテーマ内の画像URLを簡単に指定する(2018年5月27日 更新)

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

HTML entities button:プラグイン作ってみました(2017年12月17日 更新)

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字(HTMLエンティティ)を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。