- サイトデザイン工事中です。ご意見をお寄せください。
- 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細)
関数リファレンス/register deactivation hook
提供:WordPress Codex 日本語版
< 関数リファレンス
この関数register_deactivation_hookはプラグインが停止されたときに実行される関数を登録します(WordPress2.0から導入されました)。
使用法
<?php register_deactivation_hook($file, $function); ?>
引数
- $file
- (string) (必須) wp-content/plugins ディレクトリにあるプラグインのメインファイルへのパス。フルパスである必要があります。
- 初期値: なし
- $function
- (callback) (必須) プラグインが停止されたときに実行される関数名。PHPにおける疑似的な型callbackとして許可されたものである必要があります。
- 初期値: なし
使用例
次に上げるいずれかのプラグインメインファイルにmyplugin_deactivate()という関数を書いた場合を想定します。
- wp-content/plugins/myplugin.php
- wp-content/plugins/myplugin/myplugin.php
コードはこのようになります:
register_deactivation_hook( __FILE__, 'myplugin_deactivate' );
これでプラグインの停止時にmyplugin_deactivate()が呼び出されます。
関連項目
- See also register_activation_hook