プラグインBreadcrumb NavXTのbcn_post_terms関数の使用方法・解説

概要

bcn_post_terms関数は、WordPressのBreadcrumb NavXTプラグインに属する関数で、投稿やカスタム投稿タイプのタクソノミー用のパンくずリストを生成するのに使われます。この関数は、特定の投稿に関連付けられた用語（カテゴリやタグなど）を取得し、それらをパンくずリストに追加する機能を提供します。以下のような機能を実装する際によく使用されます。

カスタム投稿タイプでのタクソノミーの表示
商品やイベントの詳細ページにおけるナビゲーション
カテゴリーページからの詳細ページへのリンク
SEO向上のための内部リンク戦略
ユーザーのナビゲーション体験向上
エラーページからのユーザー誘導

この関数は、Breadcrumb NavXTプラグインのバージョンX.XX以降に使用可能で、WordPressのバージョン4.0以上に対応しています。

構文

bcn_post_terms( $post_id, $taxonomy, $args );

パラメータ

$post_id (int) – 投稿のID。
$taxonomy (string) – タクソノミーのスラッグ（例：category, post_tag）。
$args (array) – 追加の引数。

戻り値

(string) – 簡易的なHTML形式でタクソノミー用語を返します。

この関数のアクションでの使用可能性

アクション	使用可能性
mu_plugin_loaded
registered_post_type
plugins_loaded
wp_roles_init
setup_theme
after_setup_theme
set_current_user
init
register_sidebar
wp_loaded
send_headers
parse_query
pre_get_posts
wp
template_redirect
get_header
wp_head

サンプルコード

サンプルコード1: 投稿に関連するタクソノミーの取得

$post_id = get_the_ID();
$taxonomy = 'category'; // 'category'タクソノミーを指定
$terms = bcn_post_terms($post_id, $taxonomy);
echo '<div class="taxonomy-terms">' . $terms . '</div>';

このコードは、現在の投稿に関連するカテゴリを取得し、HTML内に出力します。

サンプルコード2: カスタムタクソノミーのパンくずリスト生成

$post_id = 42; // 特定の投稿ID
$taxonomy = 'custom_tax'; // カスタムタクソノミー
$args = array('before' => '<span>', 'after' => '</span>');
$terms = bcn_post_terms($post_id, $taxonomy, $args);
echo $terms;

このコードは、特定の投稿IDへのカスタムタクソノミー用語を、HTMLの要素を使って出力します。

サンプルコード3: タクソノミー用語をカスタマイズして表示

$post_id = get_the_ID();
$taxonomy = 'post_tag';
$terms = bcn_post_terms($post_id, $taxonomy, array('separator' => ' | '));
echo 'Tags: ' . $terms;

このコードは、投稿のタグを取得し、各用語を「 | 」で区切って表示します。

サンプルコード4: パンくずリストのスタイルを調整

$post_id = get_the_ID();
$taxonomy = 'category';
$args = array('before' => '<li>', 'after' => '</li>');
$terms = bcn_post_terms($post_id, $taxonomy, $args);
echo '<ul class="breadcrumb">' . $terms . '</ul>';

このコードは、取得したカテゴリをリスト形式で表示し、スタイルを適用します。

サンプルコード5: 複数のタクソノミー用語を同時に表示

$post_id = get_the_ID();
$categories = bcn_post_terms($post_id, 'category');
$tags = bcn_post_terms($post_id, 'post_tag');
echo 'Categories: ' . $categories . '<br>';
echo 'Tags: ' . $tags;

このコードは、投稿に関連するカテゴリとタグをそれぞれ表示します。

これらのサンプルコードは、bcn_post_terms関数の使い方を示しており、具体的な応用方法を示しています。

概要

構文