プラグインBreadcrumb NavXTのbcn_before_loopアクションの使用方法・解説

概要

bcn_before_loopは、WordPressのBreadcrumb NavXTプラグインにおけるアクションフックで、パンくずリストの生成が始まる前に特定のカスタム処理を実行するために使用されます。このフックは、表示前に必要な情報を追加したり、カスタムデザインやスクリプトを挿入したりする際によく使われます。

使用例

パンくずリストのデザインをカスタマイズする
パンくずリストの前に特定のHTMLコンテンツを挿入する
パンくずリストの動的データを取得して表示する
スクリプトやスタイルシートを特定のページで条件付きでロードする
トラッキングコードを挿入する
SEO向けのメタタグを追加する

構文

do_action('bcn_before_loop');

パラメータ

なし

戻り値

なし

使用可能なバージョン

Breadcrumb NavXT: 6.0.0 以降
WordPress: 4.0 以降

サンプルコード

サンプルコード 1

add_action('bcn_before_loop', 'my_custom_breadcrumb_before');
function my_custom_breadcrumb_before() {
    echo '<div class="breadcrumb-custom">ここにカスタムコンテンツが表示されます。</div>';
}

このサンプルは、パンくずリストの前にカスタムHTMLを表示する例です。

サンプルコード 2

add_action('bcn_before_loop', 'my_breadcrumb_script_loader');
function my_breadcrumb_script_loader() {
    if (is_page('about')) {
        echo '<script>console.log("Aboutページのパンくずリストが表示されます");</script>';
    }
}

このサンプルは、「About」ページの場合にのみスクリプトを読み込む例です。

サンプルコード 3

add_action('bcn_before_loop', 'my_breadcrumb_meta_tags');
function my_breadcrumb_meta_tags() {
    if (is_single()) {
        echo '<meta name="description" content="このページの説明文">';
    }
}

このサンプルは、単一投稿ページにメタタグを追加する例です。

サンプルコード 4

add_action('bcn_before_loop', 'my_breadcrumb_custom_styles');
function my_breadcrumb_custom_styles() {
    echo '<style>.breadcrumb-custom { color: #0073aa; }</style>';
}

このサンプルは、パンくずリスト用のカスタムスタイルを追加する例です。

サンプルコード 5

add_action('bcn_before_loop', 'my_breadcrumb_dynamic_data');
function my_breadcrumb_dynamic_data() {
    $current_user = wp_get_current_user();
    if ($current_user->exists()) {
        echo '<p>Welcome, ' . esc_html($current_user->display_name) . '</p>';
    }
}

このサンプルは、ログインしているユーザーの名前をパンくずリストの前に表示する例です。

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

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

概要

使用例

構文