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

概要

bcn_breadcrumb_assembled_json_ld_arrayは、WordPressのプラグインBreadcrumb NavXTにおけるフィルターフックです。このフィルタは、構築されたパンくずリストのJSON-LD形式の出力を変更するために使われます。JSON-LDは、検索エンジンに対してデータを構造化して提供するための方法であり、特にSEO（検索エンジン最適化）において重要です。このフィルタは、さまざまなカスタマイズを持つパンくずリストを生成する際に役立ちます。

よく使われる機能は以下の通りです：

SEOのための構造化データの追加
パンくずリストの要素のカスタマイズ
特定のページに対するカスタマイズされた出力
テーマやプラグインによるデータの拡張
JSON-LDの特定のプロパティの変更
ユーザー定義のデータを追加

構文

add_filter( 'bcn_breadcrumb_assembled_json_ld_array', 'custom_function_name', 10, 1 );

パラメータ

array $json_ld_array: デフォルトのJSON-LD形式の配列。

戻り値

変更されたJSON-LD形式の配列を返します。

使用可能なプラグインとバージョン

プラグイン名：Breadcrumb NavXT
バージョン：6.6.0（2023年10月現在）

WordPressのバージョン

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

add_filter( 'bcn_breadcrumb_assembled_json_ld_array', 'modify_json_ld_output' );

function modify_json_ld_output( $json_ld_array ) {
    // パンくずリストにカスタムプロパティを追加
    $json_ld_array['@context'] = 'https://schema.org';
    return $json_ld_array;
}

このサンプルコードでは、生成されるJSON-LDに@contextプロパティを追加しています。

サンプルコード 2

add_filter( 'bcn_breadcrumb_assembled_json_ld_array', 'add_custom_data_to_json_ld' );

function add_custom_data_to_json_ld( $json_ld_array ) {
    // ページのタイトルを追加
    $json_ld_array['itemListElement'][0]['name'] = get_the_title();
    return $json_ld_array;
}

このサンプルコードは、最初のパンくずリスト要素に現在のページタイトルを追加します。

サンプルコード 3

add_filter( 'bcn_breadcrumb_assembled_json_ld_array', 'remove_default_schema_properties' );

function remove_default_schema_properties( $json_ld_array ) {
    // 不要なプロパティを削除
    unset( $json_ld_array['@type'] );
    return $json_ld_array;
}

このサンプルでは、生成されたJSON-LDから@typeプロパティを削除しています。

サンプルコード 4

add_filter( 'bcn_breadcrumb_assembled_json_ld_array', 'customize_breadcrumb_schema' );

function customize_breadcrumb_schema( $json_ld_array ) {
    // カスタムデータを追加
    $json_ld_array['itemListElement'][] = [
        '@type' => 'ListItem',
        'position' => 3,
        'name' => 'カスタム要素',
        'item' => 'https://example.com/custom-item'
    ];
    return $json_ld_array;
}

このサンプルコードは、パンくずリストにカスタム要素を追加しています。

サンプルコード 5

add_filter( 'bcn_breadcrumb_assembled_json_ld_array', 'alter_json_ld_element_order' );

function alter_json_ld_element_order( $json_ld_array ) {
    // 要素の順序を変更
    $json_ld_array['itemListElement'] = array_reverse( $json_ld_array['itemListElement'] );
    return $json_ld_array;
}

このサンプルコードでは、生成されたパンくずリスト要素の順序を反転させています。

これらのサンプルコードを参考にして、Breadcrumb NavXTのフィルター機能を利用してパンくずリストのJSON-LD出力をカスタマイズすることが可能です。

概要

構文