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



お勧め

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

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

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

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。