README

このパッケージは、WordPressのパンくずリストを生成する、ライブラリです。

このパッケージは、ponponcat向けに制作されたものですが、ponponcat以外のテーマでも使用可能です。

Composerでのインストールについて

次のコマンドを実行する事で、インストール可能です。

composer require ponponumi/ponponcat_breadcrumb

サンプルコード

まず、functions.phpに、以下のように記述してください。

require_once __DIR__ . "/vendor/autoload.php";

use Ponponumi\PonponcatBreadcrumb\BreadcrumbData;
use Ponponumi\PonponcatBreadcrumb\BreadcrumbWeb;

(function()  {
    $breadcrumb = new BreadcrumbWeb();
    $breadcrumb->topPageNameChange("トップページ");
    $breadcrumb->microdataModeSet(false);
    $breadcrumb->searchResultSideChange("ワード: ", " の検索結果");
    $breadcrumb->dateFormatChangeJapan();

    add_action("wp_head", function () use ($breadcrumb) {
        $breadcrumb->jsonLd();
    });

    add_action("ponponcat_breadcrumb", function () use ($breadcrumb) {
        $breadcrumb->html();
    });
})();

次に、HTMLパンくずリストを出力したい場所に、次のように記述してください。

do_action("ponponcat_breadcrumb");

この場合、JSON-LD形式のパンくずリストと、HTML形式のパンくずリストを、出力できます。

ライセンスについて

このパッケージは、GPL 2.0 (GNU GENERAL PUBLIC LICENSE 2.0)として作成されています。

このパッケージを使い、商用利用、再配布、改変は可能ですが、ソースコードを非公開のまま配布したり、互換性のないライセンス(MITなど)を適用させたりすることはできません。