lib/plugin.php

CVS Rev. 1.15

set_plugin_messages($messages)

  • プラグイン用に未定義の変数を設定
    • 配列$messages の各キーの名前とその要素を、グローバル変数の名前とその値として登録します
      • すでに同名の定義があった場合は、上書きしません。
      • 読み込まれている各言語用のメッセージファイル*.lng.phpのメッセージ設定を優先し、開発側の想定と違うバージョンを利用しているなどでメッセージが不足する場合に補完する、という使い方が主となります

exist_plugin($name)

  • プラグインファイルが存在するか
    • 基本的に、この関数を直接呼び出す必要がありません
    • 実行できるようにファイルを読み込みます
    • ファイルが存在すればTRUE を、なければFALSE を返します

exist_plugin_action($name)

  • プラグイン(action) 関数が存在するか
    • 基本的に、この関数を直接呼び出す必要がありません
    • do_plugin_action() から呼び出されます
    • exist_plugin() を内部で呼び出します
    • $name に、プラグイン名の文字列を
    • plugin_<プラグイン名>_action() が存在すればTRUE を、なければFALSE を返します

exist_plugin_convert($name)

  • プラグイン(convert) 関数が存在するか
    • exist_plugin() を内部で呼び出します
    • $name に、プラグイン名の文字列を
    • plugin_<プラグイン名>_convert() が存在すればTRUE を、なければFALSE を返します

exist_plugin_inline($name)

  • プラグイン(inline) 関数が存在するか
    • exist_plugin() を内部で呼び出します
    • $name に、プラグイン名の文字列を
    • plugin_<プラグイン名>_inline() が存在すればTRUE を、なければFALSE を返します

do_plugin_init($name)

  • プラグインの初期化を実行
    • 基本的に、この関数を直接呼び出す必要がありません
    • do_plugin_action(), do_plugin_convert(), do_plugin_inline() から呼び出されます

do_plugin_action($name)

  • プラグイン(action)を実行
    • exist_plugin_action() を内部で呼び出します
    • do_plugin_init() を内部で呼び出します
    • $name に、プラグイン名の文字列を
    • plugin_<プラグイン名>_action() が存在しなければFALSE を返します。

do_plugin_convert($name, $args = '')

  • プラグイン(convert)を実行
    • PHP エラーを防止するため、exist_plugin_convert() を事前に実行して、そのプラグインにconvert 型が存在するかを確認して下さい
    • $name に、プラグイン名の文字列を
    • $args に、#プラグイン(引数リスト) の() 内の文字列すべてを
    • エラーメッセージまたは実行結果のHTML ソースが返ってきます。

do_plugin_inline($name, $args, & $body)

  • プラグイン(inline)を実行
    • PHP エラーを防止するため、exist_plugin_inline() を事前に実行して、そのプラグインにinline 型が存在するかを確認して下さい
    • $name に、プラグイン名の文字列を
    • $args に、&プラグイン名(引数リスト){文字列}; の() 内の文字列すべてを
      • 省略不可。何も引数を指定しない場合は、空文字を送る事。
    • $body に、&プラグイン名(引数リスト){文字列}; の{} 内の文字列すべてを
      • 省略不可。何も文字列を指定しない場合は、空文字を送る事。
    • エラーメッセージまたは実行結果のHTML ソースが返ってきます。

トップ   編集 凍結 差分 バックアップ 添付 複製 名前変更 リロード   新規 一覧 検索 最終更新   ヘルプ   最終更新のRSS
Last-modified: 2009-05-07 (木) 23:04:58
Site admin: PukiWiki Development Team

PukiWiki 1.5.2+ © 2001-2019 PukiWiki Development Team. Powered by PHP 5.6.40-0+deb8u7. HTML convert time: 0.185 sec.

OSDN