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

概要

bcn_breadcrumb_url関数は、WordPressのBreadcrumb NavXTプラグインにおいて、パンくずリストの各項目のURLを生成するために使用されます。この関数は、サイトのナビゲーションを改善し、ユーザーがどのページにいるかを明確に示すために役立ちます。具体的には、以下のような機能を実装する際によく使われます。

ナビゲーションメニューの構造化
SEO対策としてのパンくずリストの実装
ユーザビリティ向上のためのページ遷移の明示化
商品ページの詳細情報表示
カスタムポストタイプとカテゴリーのリンク生成
多言語サイトでのURL処理

構文

bcn_breadcrumb_url( $link, $title, $separator );

パラメータ

$link (string) – 生成するURLのリンク
$title (string) – リンクに表示するタイトル
$separator (string) – リンク間の区切り文字（オプション）

戻り値

(string) – 生成されたパンくずリンクのHTML

推奨バージョン

Breadcrumb NavXTのバージョン: 6.5
WordPressのバージョン: 5.8

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

アクション	使用例
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

// パンくずリストの項目を生成
$link = 'https://example.com/page';
$title = 'ページ名';
$separator = ' > ';
echo bcn_breadcrumb_url($link, $title, $separator);

このサンプルコードは、指定されたリンクとタイトルを使って、パンくずリストのURLを生成して表示します。

サンプルコード2

// カスタムポストタイプのパンくずリストを生成
$post_type = get_post_type();
if ($post_type) {
    $link = get_post_type_archive_link($post_type);
    $title = post_type_archive_title('', false);
    echo bcn_breadcrumb_url($link, $title);
}

このコードは、現在のカスタムポストタイプのアーカイブページのURLを生成し、パンくずリストとして表示します。

サンプルコード3

// タクソノミーのパンくずリストリンク
$taxonomy = 'category';
$term_id = get_queried_object_id();
$link = get_term_link($term_id, $taxonomy);
$title = get_term($term_id, $taxonomy)->name;
echo bcn_breadcrumb_url($link, $title);

このコードは、現在のタクソノミー（例: カテゴリー）のリンクとその名前を用いて、パンくずリストのURLを生成します。

サンプルコード4

// ページのパンくずリストにカスタムリンクを追加
$custom_url = 'https://example.com/custom';
$custom_title = 'カスタムリンク';
echo bcn_breadcrumb_url($custom_url, $custom_title, ' | ');

このサンプルでは、カスタムURLとタイトルを用いて、特定のセパレーターで生成されたパンくずリストのリンクを表示します。

サンプルコード5

// 別の条件でパンくずリストを表示
if (is_single()) {
    $link = get_permalink();
    $title = get_the_title();
    echo bcn_breadcrumb_url($link, $title);
}

このコードは、シングル投稿ページで現在の投稿のURLとタイトルを使用して、パンくずリストのリンクを生成します。

概要

構文