register_uninstall_hook

説明

void register_uninstall_hook( string $file, mixed $function )
プラグインのアンインストール時に呼び出される関数を登録する。

パラメータ

  • $file
    プラグインのパス名を指定
  • $function
    呼び出される関数を指定

返り値

返り値はありません。

注意

WordPress 3.1以降、パラメータ$functionに指定できる関数にはクラスメソッドを使用できない。具体的には、次のような指定はNGとなり、関数の登録に失敗する。
register_uninstall_hook( __FILE__, array( &$this, 'myplugin_uninstall' ) );
なお、プラグインのアンインストール時の処理としては、プラグイン自身のディレクトリにuninstall.phpファイルを用意する方法もある。その場合、WP_UNINSTALL_PLUGINが定義されているか、アンインストール処理前にチェックしなければならない。
//if uninstall not called from WordPress exit
if ( !defined( 'WP_UNINSTALL_PLUGIN' ) )
	exit ();

delete_option( 'example' );

使用例

  • プラグインのアンインストール時に呼び出される関数としてmyplugin_uninstall関数を登録する。
    <?php register_uninstall_hook( __FILE__, 'myplugin_uninstall' ); ?>

フィルター

実行するフィルターはありません。

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/plugin.php

最終更新 : 2013年01月18日 13:17



お勧め

Login rebuilder 2.6.0の新機能紹介(2019年4月22日 更新)

今回追加したものは、REST API / Usersの使用をログイン時のみ使用できるように制限する機能である。この機能を有効にすることで、管理者情報が漏洩するリスクを低減させる効果が期待できる。

query_posts(WP_Queryクラス)で投稿タグを絞り込む(2011年9月14日 更新)

投稿タグの絞り込みは、カテゴリーに似ているけど微妙に違っている。今日は、昨日投稿した「query_posts(WP_Queryクラス)でカテゴリーを絞り込む」の続きとして、投稿タグの絞り込みついてまとめてみる。

classic editorプラグインを試してみた(2018年12月10日 更新)

WordPress 5.0 beta1のリリースにあわせて旧エディター環境を実現できる「classic editor」(バージョン0.5.0)が公開された。自分が公開しているプラグインの一部が旧エディター環境に依存していることもあり、さっそく試してみた。WordPress 5.0正式リリースに合わせてclassic editorも1.0がリリースされたので、それについて追記しました。

コメントの「ウェブサイト」止めました(2014年4月15日 更新)

とあるサイトのスパムコメントが多く、その都度のスパム指定するのが面倒である。これまでいくつか対策を行ってきたが、そういった対応にもいい加減うんざりしてきたので、試験的に「ウェブサイト」を無効化しようと思った。

プラグインの設定ページもレスポンシブ対応(2014年6月3日 更新)

レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。