WordPress.org

Make WordPress Core

Opened 6 years ago

Last modified 2 days ago

#14955 new enhancement

Themes should support uninstall.php or uninstall hook

Reported by: WraithKenny Owned by:
Milestone: Awaiting Review Priority: normal
Severity: normal Version:
Component: Themes Keywords: has-patch dev-feedback
Focuses: Cc:

Description (last modified by scribu)

Related tickets on extending Themes to have Plugin features: #7795 and #14849 but those deal primarily with activation and deactivation centering around 'switch_themes' action.

From looking at /wp-admin/includes/plugin.php, adding support for uninstall is a separate concern (and it doesn't have the issue blocking activation/deactivation).

Should is_uninstallable_plugin, register_uninstall_hook and uninstall_plugin be extended to check theme directory or should versions (is_uninstallable_theme, register_uninstall_theme_hook and uninstall_theme) be added to theme.php?

Advantage of the first method is that the register_uninstall_hook could be reused for Themes where in the second, a new, less attractive name would be needed (register_uninstall_theme_hook?) Also, there's no theme_basename as it was reverted/removed.

Attachments (3)

14955.diff (1013 bytes) - added by greuben 5 years ago.
14955.1.diff (1.2 KB) - added by obenland 3 years ago.
Refreshed patch
14955.2.patch (785 bytes) - added by vetyst 3 months ago.
v4.6 deleted_theme hook

Download all attachments as: .zip

Change History (35)

#1 @scribu
6 years ago

We shouldn't attempt to reuse register_*_hook() functions because there's only one theme running at a time, so the underlying logic would be very different.

That's why there's no theme_basename() and why the $file parameter wouldn't be needed.

#2 @scribu
6 years ago

  • Description modified (diff)

#3 @scribu
6 years ago

Forget what I said, as it doesn't apply to the uninstall process.

#4 @scribu
6 years ago

  • Keywords needs-patch 3.2-early added
  • Milestone changed from Awaiting Review to Future Release

#5 @WraithKenny
6 years ago

  • Cc Ken@… added

#6 @scribu
6 years ago

Related: #7795

(duh, it's in the ticket description)

Last edited 6 years ago by scribu (previous) (diff)

#7 @chipbennett
6 years ago

  • Cc chip@… added

So, at Scribu's prompting, I'm going to attempt to create a patch for this. I'm thinking of creating analogous functions in themes.php, unless either of you think I should go the route of extending the existing Plugin hooks?

(Should I assign this to myself? I am still mostly unfamiliar with Trac workflow.)

#8 @scribu
6 years ago

You can assign it to yourself, if you want, but it's not mandatory.

Extending register_uninstall_hook() is not an option.

The available options are:

  • uninstall.php file
  • register_theme_uninstall_hook()

@greuben
5 years ago

#9 @greuben
5 years ago

  • Keywords 3.3-early has-patch added; needs-patch 3.2-early removed

Instead of register_theme_uninstall_hook() we can use 'uninstall_theme' hook.

14955.diff makes use of uninstall.php and introduces 'uninstall_theme' hook.

#10 @scribu
5 years ago

  • Keywords early added; 3.3-early removed

#11 @DrewAPicture
5 years ago

  • Cc xoodrew@… added

#19505 closed as duplicate.

#12 @oncletom
4 years ago

  • Cc thomas@… added

Any progress on this topic?

#13 @DeanMarkTaylor
3 years ago

  • Cc DeanMarkTaylor added

@obenland
3 years ago

Refreshed patch

#14 @obenland
3 years ago

  • Keywords early removed
  • Milestone changed from Future Release to 3.7

#16 follow-up: @nacin
3 years ago

This doesn't seem like functionality I'd want themes to have.

#17 @WraithKenny
3 years ago

@nacin Theme's can add options, create tables, and do all sorts of things that plugins can do, but has little opportunity to clean up after themselves. Shouldn't themes clean up like plugins are expected to?

#18 in reply to: ↑ 16 @helen
3 years ago

  • Milestone changed from 3.7 to Awaiting Review

Replying to nacin:

This doesn't seem like functionality I'd want themes to have.

#19 @Apiweb
3 years ago

  • Version 3.0.1 deleted

As the WraithKenny said, has many themes that add tables, alter the structure of WordPress, and with all the powerful API of WordPress they can do a lot more, I believe this would be an interesting option to be implemented.

This ticket was mentioned in Slack in #meta by sterlo. View the logs.


21 months ago

This ticket was mentioned in Slack in #cli by sterlo. View the logs.


21 months ago

#22 @chriscct7
15 months ago

#16401 was marked as a duplicate.

#23 @kjodle
15 months ago

Some themes are doing this already. It would be beneficial to keep the database clean, and to ensure that all themes are doing this in a uniform way. Perhaps as all themes migrate to using the customizer, this can be implemented.

#24 @chriscct7
15 months ago

  • Keywords dev-feedback added

#25 @muxahuk1214
15 months ago

Any progress on this topic? May be you could implement only do_action for now ?

Last edited 15 months ago by muxahuk1214 (previous) (diff)

This ticket was mentioned in Slack in #core by ocean90. View the logs.


4 months ago

#27 @swissspidy
3 months ago

#37951 was marked as a duplicate.

@vetyst
3 months ago

v4.6 deleted_theme hook

#28 @vetyst
3 months ago

  • Severity changed from normal to blocker

I would really want this feature to be implemented aswell, I had a round about way for catching theme deletions before by checking if the script wp-admin/theme.php was used. Unfortuanetly since 4.6 this no longer works as everything goes through ajax.

A simple hook would be sufficient as profided in 14955.2.patch!

#29 @obenland
3 months ago

  • Severity changed from blocker to normal

#30 @swissspidy
3 months ago

#38001 was marked as a duplicate.

#31 @okvee
2 weeks ago

I have a very simple theme that has no feature, just index.php style.css and screenshot.png.

WordPress have customizer and save settings in the db. (Its name is theme_mods_MYTHEMENAME in the options table.)

When I delete my theme WordPress did not delete that value in the db.

And @nacin said "This doesn't seem like functionality I'd want themes to have."!
I don't think you love junk.

Please have a function to work on delete/uninstall the theme.

#32 @swissspidy
2 days ago

@okvee Theme mods are somewhat different. I understand this ticket to be about helping themes to remove their custom tables etc. on uninstall (which themes really shouldn't use). Theme mods are handled by WordPress and crucial to the overall UX. When changing themes and previewing them in the customizer, I want to have the same modifications (e.g. custom CSS) applied as before. I don't want this data to get lost.

Note: See TracTickets for help on using tickets.