【Breadcrumb NavXT】liタグなどで属性を利用するカスタマイズ方法

「Breadcrumb NavXT」は、WordPressでパンくずリストを簡単に表示できるプラグイン。

「Breadcrumb NavXT」の設定画面では、パンくずの項目ごとにHTMLテンプレートを設定できますが、そのテンプレート内で属性を利用できないHTMLタグ（liタグなど）があります。

今回は、そのようなHTMLタグに対して、属性を許可する方法となります。

【Breadcrumb NavXT】liタグなどで属性を利用する方法

Breadcrumb NavXTでは、プラグインの独自フックbcn_allowed_htmlによって、パンくずリストのテンプレート内のHTMLタグに対して、指定した属性を許可できます。

以下、functions.phpに記述するフィルターフックbcn_allowed_htmlの例となり、liタグに対して指定した属性を利用できるようにカスタマイズしています。

function my_bcn_allowed_html($allowed_html){
    // 配列$allowed_htmlのキーに、カスタマイズするHTMLタグを指定
    $allowed_html['li'] = array(
        // 属性を許可する場合、属性をキーとして値をtrueとします
        'title' => true,
        'class' => true,
        'id' => true,
        'dir' => true,
        'align' => true,
        'lang' => true,
        'xml:lang' => true,
        'aria-hidden' => true,
        'data-icon' => true,
        'itemref' => true,
        'itemid' => true,
        'itemprop' => true,
        'itemscope' => true,
        'itemtype' => true
    );
    return $allowed_html;
}
add_filter('bcn_allowed_html', 'my_bcn_allowed_html');

ソースコードの説明

プラグインの独自フックbcn_allowed_htmlでは、コールバック関数の引数を上書きして返すことにより、指定したHTMLタグに対して、指定した属性をそれぞれ許可してカスタマイズできます。

コールバック関数内では、カスタマイズするHTMLタグを指定するため、コールバック関数の引数にセットされている配列に対して、HTMLタグ名をキーとして指定します。

HTMLタグ名をキーとして指定した要素の値は、HTMLタグの属性をキーとした配列となり、その属性のキーの値をtrueとして返すことで、指定した属性を許可できます。