Misc. Functions
提供: GeeklogJpWiki
その他の(Misc)関数
その他の目的のための（追加の）機能のリストを次に示します。
| 関数 | 説明 |
|---|---|
| plugin_centerblock_<プラグイン名> | プラグインはサイトの中央部にブロックを表示できます。この関数はサイトのindexページをレンダリングする際に数回呼ばれます。引数によってindexページのどこにブロックを表示するか決まります。 引数は表示場所（1=ページ最上部、2=注目記事の後、3=ページ最下部）、ページ番号、topic idとなります。表示場所については0をとることもできます。0 の場合はプラグインがページ全体を置き換えてしまいます（この場合ページ全体のHTMLを返す必要があります。すなわちサイトのヘッダやフッタも含まれているHTMLです）。 |
| plugin_getheadercode_<プラグイン名> | この機能を実装することでプラグインはサイトの<head>タグに行を追加できます。例えばJavascript関数や追加のメタタグなどです。 関数は追加のヘッダ行をすべて連結した文字列を返す必要があります。 |
| plugin_templatesetvars_<プラグイン名> | プラグインでテンプレート変数を追加できます。この関数は現在のところCOM_siteHeaderおよびCOM_siteFooterで呼ばれるだけですが、将来は他の場面でも呼ばれることになるでしょう。引数はテンプレート名とテンプレートオブジェクトへの参照です。このプラグインAPIはテンプレート名（現在のところ'header'か'footer'）をチェックしてテンプレートオブジェクトの参照を利用して要求のあったどのような新規の変数も設定します。 |
| plugin_whatsnewsupported_<プラグイン名> | プラグインはこの関数および以下の関数を実装することでGeeklogの新着情報ブロックに自身のセクションを追加することができます。 この関数は2つの文字列からなる配列を返します。最初の文字列は新着情報のプラグインセクションのヘッドラインとして使われます。2番目の文字列はこのセクションエントリが取り上げる期間を示します（例えば過去2週間）。 |
| plugin_getwhatsnew_<プラグイン名> | この関数は新着情報ブロックにリストアップされる新エントリ（配列として）か、エントリのない場合に表示される文字列を返します。 |
| plugin_chkVersion_<プラグイン名> | プラグインはバージョンを返すこの関数を実装する必要があります。新規のバージョンをリリースする前に簡単にバージョンを更新できるようにするため、プラグインのconfig.phpにある変数でバージョンを指定すべきです。Geeklog 1.3.10ではこのAPI関数はプラグインエディタで、現在インストールされているプラグインのバージョンとこれから入れようとしているプラグインのバージョンを表示するために呼ばれます。。このインストールされているプラグインのバージョンはpluginsテーブルから引き出され、プラグインのインストールや更新の際には更新されます。このAPI関数によって管理者はこれから入れようとしているプラグインが既にインストールされているバージョンより新しいかどうかを知ることができます。プラグイン開発者にとってはpluginsテーブルから既にインストールされたバージョンを知ることができ、自動的にSQLによる更新が必要かどうか、あるいは少なくともプラグインの新バージョンに対応するようプラグインレコードを更新べきかを決定することができます。 |
| plugin_runScheduledTask_<プラグイン名> | この関数によってプラグイン開発者が定期的にあるタスクを実行させることができます。このAPIは誰かがサイトにアクセスしたときにのみ呼び出されますが、メンテナンスや このAPIが呼ばれる間隔はサイトのconfig.phpで設定され、この関数をもつ全てのプラグインがその間隔で呼び出されます。 |
