register_uninstall_hook

（2.7以降）
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

関連

参考

Code Reference: register_uninstall_hook

お勧め

5.3の新機能：クエリーログに任意の項目を追加できる新フィルター（2019年10月23日 更新）

「5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。

ログインページのタイトルを変更してみる（2018年5月27日 更新）

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。

プラグインで注意が必要な関数（2013年11月27日 更新）

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

ブロックエディターの色設定を変えてみる（2019年12月11日 更新）

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

KUSANAGIでマルチサイト（サブドメイン）を試した（2019年8月6日 更新）

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。