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

お勧め

フィードにサムネイル画像を追加する（2022年11月1日 更新）

WordPressが出力するの標準のフィードには、各投稿のサムネイル画像の情報が含まれていない。ネットで検索してみるといくつかの方法があることがわかったので、その中から2つ試してみた。

投稿一覧に「投稿フォーマット」フィルターが追加される（2019年4月12日 更新）

WordPress 5.2 Beta2（以降5.2Beta2）のソースコードを眺めていると、投稿一覧ページのフィルター機能に「投稿フォーマット」（select要素）が追加されていた。

5.5の機能強化：コメントフォームのちょっとした改良（2020年8月12日 更新）

来月にリリースされるWordPress 5.5に向けてBeta 1、2、3と公開が続いている。「WordPress 5.5 Beta 3（以降Beta 3）」のソースコードを見ていくと、コメントフォームを表示する comment_form関数が機能拡張されていた。

Login rebuilderに「XML-RPC設定」を追加しました（2018年5月27日 更新）

公式サイトで公開しているプラグイン「Login rebuilder」をバージョンアップし、XML-RPCリクエストの管理機能を追加しました。Login rebuilderの主たる機能は、ログインページをサイト別にユニークなURLに変更し、ログインページへの不正アクセスを回避することです。WordPressのXML-RPCリクエストはピンバックや外部ツールやサイトなどとの連携に利用されていますが、今回追加した機能ではXML-RPCリクエストの処理に対していくつかの制限できるようにしています。

index.htmlでアーカイブページを表示させる（2011年10月14日 更新）

静的なサイトでは、各ディレクトリにindex.htmlファイルを置き、そのディレクトリの内容を紹介することが多い。WordPressで構築したサイトも同様にできないかと考え、試行錯誤してみた（こんなことを考えてるのは自分だけだろうか！？）。