jsonld.inc.php

名称ページ情報表示プラグイン
ファイルjsonld.inc.php
バージョン1.00
対象サーバーPukiWiki 1.5.3 / PHP 7.4 / UTF-8
対象ブラウザーFirefox, Chrome, Safari, Edge 各最新版
ライセンスGPLv3

JSON-LDを出力するPukiWiki用プラグイン。

ページの情報に基づくJSON-LD構造化データを生成し出力します。具体的には、記事情報Articleとパンくずリスト情報BreadcrumbListを生成します。ウィキの構造を検索エンジンにより良く伝えるため(SEO)に役立ちます。

インストール

jsonld.inc.php
3.5KB | 2020-05-13

jsonld.inc.phpPukiWikipluginディレクトリに配置してください。

使い方

#jsonld

MenuBarなど全画面共通で表示されるページに挿入してください。
もしくは、次のコードをスキンファイルHTML内の</body>閉じタグ直前に挿入してください*1

<?php if (exist_plugin_convert('jsonld')) echo do_plugin_convert('jsonld'); ?>

なお、本プラグインを挿入できるのは1ページにつき1箇所のみです。

設定

コード内の下記の定数で動作を制御することができます。

定数名既定値意味
PLUGIN_JSONLD_ARTICLE0 or 111:Article (記事情報)を出力, 0:無効
PLUGIN_JSONLD_BREADCRUMBLIST0 or 111:BreadcrumbList (パンくずリスト情報)を出力, 0:無効

default.ini.phpへの設定

本プラグインの定数設定(ファイル内の下記のような行)は、PukiWikiルートディレクトリにある標準設定ファイルdefault.ini.phpにも記述することができます。本プラグインの定数設定行をdefault.ini.phpの末尾にそのままコピーしてください。default.ini.php側の設定値が優先されます。

/////////////////////////////////////////////////
// ○○プラグイン設定(○○.inc.php)
if (!defined('PLUGIN_○○_×××)) define('PLUGIN_○○_×××', △);

設定をdefault.ini.phpに記述することで、プラグインをアップデート(ファイル上書き)するたびに値を書き直す必要がなくなります。また、設定がdefault.ini.phpに集中することで、運用中の設定管理も楽になります。

凡例

プラグインの引数は下記の書式で表現しています。

  • [] … 省略でき必要に応じて記述します
  • | … |で区切られた項目のうち1つを記述します
  • {} … 中カッコ内の引数は任意の順序で記述できます

*1 イカスキンにはあらかじめ挿入されています。