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

概要

bcn_widget_display_trail関数は、WordPressのプラグイン「Breadcrumb NavXT」において、パンくずリストを表示するために使用される関数です。この関数は、特に以下のような機能を実装する際によく使われます。

SEO向上のためのナビゲーション表示
ユーザビリティの向上による直感的なナビゲーション
特定の投稿タイプやページでのカスタマイズされた表示
コードを介してのパンくずリストの動的生成
テーマのカスタマイズに合わせたリストのデザイン適用
ページ階層構造を視覚的に示すことでの情報整理

構文

bcn_widget_display_trail();

パラメータ

$args (配列、オプション): 表示設定に関するオプション。

戻り値

string: パンくずリストのHTML。

バージョン

Breadcrumb NavXT: 6.0.0 以降
WordPress: 5.0 以降

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

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

<?php if (function_exists('bcn_widget_display_trail')) : ?>
    <div class="breadcrumb">
        <?php bcn_widget_display_trail(); ?>
    </div>
<?php endif; ?>

このコードは、パンくずリストを表示する基本的な例です。function_existsを使って関数が定義されているか確認し、HTMLで適切にマークアップしています。

引用元: https://example.com/sample1

サンプルコード2

<?php
add_action('wp', function() {
    if (is_page()) {
        echo '<div class="breadcrumb-wrapper">';
        bcn_widget_display_trail();
        echo '</div>';
    }
});
?>

このコードでは、wpアクションフックを利用して、特定のページでのみパンくずリストを表示するようにしています。

引用元: https://example.com/sample2

サンプルコード3

<?php
function custom_breadcrumb_style() {
    echo '<style>
            .breadcrumb { 
                font-size: 14px; 
                color: #333; 
            }
          </style>';
}
add_action('wp_head', 'custom_breadcrumb_style');
bcn_widget_display_trail();
?>

このコードは、wp_headフックを使ってパンくずリストにスタイルを適用しています。表示されるパンくずリストにカスタムCSSを追加しています。

引用元: https://example.com/sample3

サンプルコード4

<?php
add_action('template_redirect', function() {
    if (is_single()) {
        echo '<div class="my-breadcrumb">';
        bcn_widget_display_trail();
        echo '</div>';
    }
});
?>

ここでは、template_redirectアクションを使い、投稿ページにのみパンくずリストを表示します。これにより、投稿に特化した表示が可能になります。

引用元: https://example.com/sample4

サンプルコード5

function display_breadcrumbs_in_sidebar() {
    if (is_active_sidebar('my-sidebar')) {
        echo '<div class="sidebar-breadcrumb">';
        bcn_widget_display_trail();
        echo '</div>';
    }
}
add_action('widgets_init', 'display_breadcrumbs_in_sidebar');

このコードは、ウィジェットエリアでパンくずリストを表示するためにwidgets_initフックを使用しています。適切に初期化されたウィジェットエリアでの表示を保証します。

引用元: https://example.com/sample5

概要

構文