プラグインBreadcrumb NavXTのbcn_display_separatorフィルタの使用方法・解説

概要

bcn_display_separatorフィルターは、WordPressのBreadcrumb NavXTプラグインにおけるパンくずリストの区切り文字をカスタマイズするために使用されます。このフィルターを使用することによって、パンくずリストの各セクション間の表示を変更することができ、サイト全体のデザインやアクセシビリティを向上させることに寄与します。

このフィルターは、次のような機能を実装する際によく使われます。

カスタム区切り文字の設定
スタイルシートに合わせたセパレーターの変更
軽いSEO対策として、特定のHTMLタグを適用
言語や地域による特別な区切りスタイルの実装
管理画面から簡単に変更できるオプションの提供
他のプラグインやテーマとの互換性を持たせるためのカスタマイズ

このフィルターは、Breadcrumb NavXTプラグインのバージョンが「6.0」以上で、WordPressのバージョンが「4.0」以上で使用可能です。

構文

add_filter('bcn_display_separator', 'custom_separator_function');

パラメータ

$separator (string): 現在使用されている区切り文字。
$position (int): 区切り文字の位置。

戻り値

このフィルターは、変更された区切り文字を返します。

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

アクション	使用可能性
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: カスタム区切り文字を設定する

add_filter('bcn_display_separator', function($separator) {
    return '|';  // 区切り文字をパイプ記号に変更
});

このサンプルコードは、パンくずリストの区切りを「|」に変更します。

サンプル2: HTMLを含む区切り文字を設定する

add_filter('bcn_display_separator', function($separator) {
    return '<span class="separator"> / </span>';  // HTMLを利用してセパレーターをスタイリング
});

このコードは、パンくずリストの各項目の間にスタイルが適用されたHTMLの区切りを挿入します。

サンプル3: 翻訳対応の区切り文字を設定する

add_filter('bcn_display_separator', function($separator) {
    return __('→', 'text-domain');  // テキストドメインを利用して翻訳対応
});

このサンプルでは、翻訳可能な区切り文字として「→」を設定しています。

サンプル4: 条件に応じたセパレーターの変更

add_filter('bcn_display_separator', function($separator) {
    if (is_single()) {
        return ' &gt; ';  // 投稿ページでは別の区切り文字を使用
    }
    return $separator;
});

このコードは、シングル投稿ページのときだけ異なる区切り文字を設定しています。

サンプル5: デフォルトの区切りを削除する

add_filter('bcn_display_separator', function($separator) {
    return '';  // 区切り文字を削除する
});

このサンプルは、パンくずリストの間に何も表示しないように区切り文字を空にしています。

概要

構文