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



お勧め

JavaScriptテンプレートを使ってみた(2018年8月21日 更新)

前回の記事」で取り上げた「WordPress Events and News」ウィジェットでは入力された地名のAJAX処理してその地名近隣のイベント情報を表示している。特に表示部分では「JavaScriptテンプレート」が採用されており、今更ながら調べてみた。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

任意の名前でエラーログファイルを指定する(2019年2月15日 更新)

来週にはWordPress 5.1がリリース。RC1のソースコードを見ていると、 wp_debug_mode関数が変更されており、興味深かった。

投稿内容のid属性などを保存するための対策(2012年6月15日 更新)

WordPress 3.4にアップデートしたとある環境で投稿記事を保存すると、divタグなどのid属性がクリアされて保存するようになった(id属性が保存できなくなった)。ここでは、その対策方法の1つを紹介しておく。

query_posts(WP_Queryクラス)でカテゴリーを絞り込む(2011年9月14日 更新)

久しぶりに query_posts関数を見直してみると、見知らぬパラメータがいくつか追加されていた。気になったのでカテゴリー関係の指定を'tax_query'パラメータを交えて整理してみた。