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

概要

bcn_show_type_term_archive 関数は、WordPressのプラグイン「Breadcrumb NavXT」に属する関数で、特定の種類のタクソノミーアーカイブページのパンくずリストを表示する際に使用されます。この関数は、サイトのナビゲーションを改善し、ユーザーに現在の位置を明確に示すために効果的です。

よく使用されるケースとしては以下のようなものがあります：
1. カスタムタクソノミーのアーカイブページの表示
2. SEO対策としてのナビゲーションの改善
3. ユーザーエクスペリエンスの向上
4. サイトの構造を明確に示す
5. メインコンテンツに対するサイドラインからの親子関係の視覚化
6. 各タクソノミーの階層を視覚化して見やすくする

この関数は、特に以下のバージョンで動作します：
– WordPressバージョン: 4.0以上
– Breadcrumb NavXTバージョン: 6.0以上

構文

bcn_show_type_term_archive($term, $type);

パラメータ

$term (オブジェクト): タクソノミー用の用語オブジェクト。
$type (文字列): タクソノミーの種類を示す文字列。

戻り値

この関数は何も返さず、パンくずリストを直接出力します。

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

アクション	使用可能性
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: タクソノミーアーカイブの表示

if (is_tax('genre')) {
    $term = get_queried_object();
    bcn_show_type_term_archive($term, 'genre');
}
// このコードは、'genre'というタクソノミーのアーカイブページでパンくずリストを表示します。

サンプルコード2: 条件付きでパンくずリストをカスタマイズ

if (is_tax('category')) {
    $term = get_queried_object();
    bcn_show_type_term_archive($term, 'category');
    // デフォルトのタクソノミー 'category' のアーカイブに対してパンくずリストを表示します。
}

サンプルコード3: カスタムタクソノミーのチェック

if (is_tax('custom_taxonomy')) {
    $term = get_queried_object();
    bcn_show_type_term_archive($term, 'custom_taxonomy');
    // 'custom_taxonomy'というカスタムタクソノミーのアーカイブでパンくずリストを表示。
}

サンプルコード4: 複数のタクソノミーを扱う

if (is_tax(['genre', 'category'])) {
    $term = get_queried_object();
    bcn_show_type_term_archive($term, $term->taxonomy);
    // 'genre' または 'category' が指定されている場合にパンくずリストを表示。
}

サンプルコード5: フィルターフックでのカスタマイズ

add_filter('bcn_after_title', function($title) {
    if (is_tax('tag')) {
        $title .= ' - タグアーカイブ';
    }
    return $title;
});
// このフィルターを使って、タグアーカイブのタイトルにカスタムテキストを追加します。

これらのサンプルコードは、bcn_show_type_term_archive 関数を利用してタクソノミーアーカイブページにパンくずリストを表示する方法を示しています。各コードはそれぞれ異なる条件や要素に基づいています。

概要

構文