jsonfeed.inc.php

名称JSON Feedプラグイン
ファイルjsonfeed.inc.php
バージョン1.02
対象サーバーPukiWiki 1.5.3 / PHP 7.4 / UTF-8
ライセンスGPLv3

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

標準プラグインrss.inc.phpJSON Feed版です。具体的には、RecentChangesをフィードに変換して出力します。出力はファイルにキャッシュし、次回からページが更新されるまで処理を省きます。

JSON Feedとは、2017年に定義されたJSON形式のウェブフィードです。XML形式のRSSAtomに比べ、パースが簡単に済みます。大量のフィードも比較的高速に処理でき、JavaScriptでの扱いも楽です。

インストール

jsonfeed.inc.php
2.6KB | 2020-05-19

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

使い方

(ウィキのURL)?plugin=jsonfeed[&ver=1.0]
  • ver … JSON Feed のバージョン。省略時の既定値は1.0

謝辞

次のプラグインを参考にし、コードを一部流用させていただきました。

rss.inc.php : Copyright 2003-2017 PukiWiki Development Team, License: GPL v2 or (at your option) any later version

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つを記述します
  • {} … 中カッコ内の引数は任意の順序で記述できます