导航|地址|刷新
Uninstall Methods – Plugin Handbook | De…


Skip to content

WordPress.org




Showcase

Plugins

Themes

Hosting

News

Resources
Learn WordPress

Documentation

Education

Forums

Developers

Blocks

Patterns

Photos

Openverse ↗︎

WordPress.tv ↗︎


About
About WordPress

Make WordPress

Events

Five for the Future

Enterprise

Gutenberg ↗︎

Job Board ↗︎

Swag Store ↗︎


Get WordPress








Search in WordPress.org






Get WordPress

WordPress.org

WordPress Developer Resources

Uninstall Methods






Developer Blog

Code Reference

WP-CLI Commands









Developer Blog

Code Reference

WP-CLI Commands








HomePlugin HandbookPlugin BasicsUninstall Methods






Search








Uninstall Methods




In this article
Table of Contents

Method 1: register_uninstall_hook

Method 2: uninstall.php

↑ Back to top



Your plugin may need to do some clean-up when it is uninstalled from a site.

A plugin is considered uninstalled if a user has deactivated the plugin, and then clicks the delete link within the WordPress Admin.

When your plugin is uninstalled, you’ll want to clear out any plugin options and/or settings specific to the plugin, and/or other database entities such as tables.

Less experienced developers sometimes make the mistake of using the deactivation hook for this purpose.

This table illustrates the differences between deactivation and uninstall.

Scenario	Deactivation Hook	Uninstall Hook
Flush Cache/Temp	Yes	No
Flush Permalinks	Yes	No
Remove Options from {$wpdb->prefix}_options	No	Yes
Remove Tables from wpdb	No	Yes

Method 1: register_uninstall_hook

To set up an uninstall hook, use the register_uninstall_hook() function:
register_uninstall_hook( __FILE__, 'pluginprefix_function_to_run' );
Method 2: uninstall.php

To use this method you need to create an uninstall.php file inside the root folder of your plugin. This magic file is run automatically when the users deletes the plugin.

For example: /plugin-name/uninstall.php





Always check for the constant WP_UNINSTALL_PLUGIN in uninstall.php before doing anything. This protects against direct access.

The constant will be defined by WordPress during the uninstall.php invocation.

The constant is NOT defined when uninstall is performed by register_uninstall_hook() .



Here is an example deleting option entries and dropping a database table:
// if uninstall.php is not called by WordPress, die if ( ! defined( 'WP_UNINSTALL_PLUGIN' ) ) { die; } $option_name = 'wporg_option'; delete_option( $option_name ); // for site options in Multisite delete_site_option( $option_name ); // drop a custom database table global $wpdb; $wpdb->query( "DROP TABLE IF EXISTS {$wpdb->prefix}mytable" );




In Multisite, looping through all blogs to delete options can be very resource intensive.






First published

September 16, 2014




Last updated


February 20, 2024




PreviousIncluding a Software LicensePrevious: Including a Software License

NextPlugin SecurityNext: Plugin Security





Chapters
Chapter list

Plugin Handbook

Introduction to Plugin Development
What is a Plugin?


Plugin Basics
Header Requirements

Activation / Deactivation Hooks

Best Practices

Determining Plugin and Content Directories

Including a Software License

Uninstall Methods


Plugin Security
Checking User Capabilities

Data Validation

Nonces

Securing (escaping) Output

Securing (sanitizing) Input


Hooks
Actions

Filters

Custom Hooks

Advanced Topics


Privacy
Adding the Personal Data Eraser to Your Plugin

Adding the Personal Data Exporter to Your Plugin

Privacy Related Options, Hooks and Capabilities

Suggesting text for the site privacy policy


Administration Menus
Sub-Menus

Top-Level Menus


Shortcodes
Basic Shortcodes

Enclosing Shortcodes

Shortcodes with Parameters

TinyMCE Enhanced Shortcodes


Settings
Custom Settings Page

Options API

Settings API

Using Settings API


Metadata
Managing Post Metadata

Custom Meta Boxes

Rendering Post Metadata


Custom Post Types
Registering Custom Post Types

Working with Custom Post Types


Taxonomies
Term Splitting (WordPress 4.2)

Working with Custom Taxonomies


Users
Roles and Capabilities

Working with User Metadata

Working with Users


HTTP API

REST API
REST API Overview

Routes & Endpoints

Requests

Responses

Schema

Controller Classes


JavaScript
Heartbeat API

jQuery

AJAX

Server Side PHP and Enqueuing

Summary


Cron
Scheduling WP Cron Events

Testing of WP-Cron

Understanding WP-Cron Scheduling

Hooking WP-Cron Into the System Task Scheduler


Internationalization
How to Internationalize Your Plugin

Internationalization Security

Localization


The WordPress.org Plugin Directory
Add Your Plugin to the Block Directory

Alerts and Warnings

Block Specific Plugin Guidelines

Common issues

Compliance Disclaimers

Detailed Plugin Guidelines

How Your Plugin Assets Work

Planning, Submitting, and Maintaining Plugins

Plugin Developer FAQ

Plugin Readmes

Previews and Blueprints

Release Confirmation Emails

Reporting Plugin Security Issues

Special User Roles and Capabilities

Take Over an Existing Plugin

Transferring Your Plugin to a New Owner

Using Subversion

Using the Forums

Using the WordPress.org MCP Server


Developer Tools
Debug Bar and Add-Ons

Helper Plugins


Creating Tables with Plugins

Credits





About

News

Hosting

Privacy

Showcase

Themes

Plugins

Patterns

Learn

Documentation

Developers

WordPress.tv ↗

Get Involved

Events

Donate ↗

Five for the Future

WordPress.com ↗

Matt ↗

bbPress ↗

BuddyPress ↗


WordPress.orgWordPress.org

Visit our X (formerly Twitter) account

Visit our Bluesky account

Visit our Mastodon account

Visit our Threads account

Visit our Facebook page

Visit our Instagram account

Visit our LinkedIn account

Visit our TikTok account

Visit our YouTube channel

Visit our Tumblr account

The WordPress® trademark is the intellectual property of the WordPress Foundation.


------
导航页 打开网址