Shiny Updates: Trigger a JS event when deleting/installing themes/plugins

[DavidAnderson]

In #37216, triggers were added to Shiny Updates to enable the existing functionality of our plugin to continue working with the changed theme update implementation. (Our plugin pops up a dialog, communicates with the back-end via AJAX to perform a backup of the site's themes, and then when the backup is complete hands back control so that the update proceeds).

Further testing has revealed another issue - the "Shiny Deletes" for plugins or themes don't work with our plugin active, and there's no way for us to hook in to make it work.

The cause is the lack of an analogous trigger on the deletion event (corresponding to the existing triggers on the update event).

The attached patch adds triggers upon plugin and theme deletion. It also adds triggers in the corresponding location upon plugin and theme install; we don't use that, but it ought to be there for completeness and to allow other plugin authors to hook in.

[DavidAnderson]

Add triggers upon shiny deletes and installs corresponding to those already present for updates

[DavidAnderson]

The corresponding patch that was committed for #37216: https://core.trac.wordpress.org/attachment/ticket/37216/37216.diff

[ocean90]

Wouldn't it be helpful to know which plugin/theme was deleted/installed/updated?

[DavidAnderson]

V2: Pass the arguments of what the event is related to along

[DavidAnderson]

You're right - we don't use that, but some consumers could find that handy. I've added that in the revised patch (including adding it to the theme and plugin updates triggers - the theme update trigger is new in WP 4.6, but the plugin update trigger exists since 4.2).

[swissspidy]

Yeah, passing the additional info makes sense. args contains the success and error callbacks though, not sure that's super helpful. Would it perhaps suffice to pass only the slug?

[DavidAnderson]

Version 3: Also provide a trigger for bulk updates

[DavidAnderson]

After much more testing, I've just provided a third version that adds a further trigger for the bulk action, which previously did not trigger anything (this also broke our code - not sure why we didn't catch this in the earlier testing when beta 1 came out).

@swissspidy: I was thinking that by passing args, we passed everything, so it's more future-proofed against any changes in what arguments there might be. I don't feel strongly either way though (we don't actually use the parameter).

[swissspidy]

'wp-plugin-bulk-action-' + bulkAction should probably be 'wp-plugin-bulk-' + bulkAction (i.e. without the -action part), otherwise trigger-update-delete-and-install3.diff​ looks fine.

[DavidAnderson]

V4: Rename bulk action as requested

[ocean90]

The bulk action handler is also used for themes. So maybe wp-' + type + '-bulk-' + bulkAction?

[DavidAnderson]

V5: Adjust to reflect fact that the bulk action handler can be invoked for themes as well as plugins

[ocean90]

@DavidAnderson Thanks!

FYI: Attachments don't trigger notifications so you should always post an additional comment when uploading a patch.

[ocean90]

@jorbin Can you review trigger-update-delete-and-install5.diff​ please?

[jorbin]

In 38175:

Upgrade/Install: Trigger additional JS events in shiny updates

Events for updating exist, but they lack context. This adds args so that plugins can detec t what plugin/theme is being installed. Additionally, events for bulk actions, deleting and that and install is starting didn't exist, so this adds them.

Fixes #37512.
Props DavidAnderson, and ocean90, swissspidy for review.

[jorbin]

In 38218:

Updates: Standardize JS Custom Event Names

Custom JS events are triggered on the document in order for plugins to have something to hook into. The standard began in #31819 is dash separated and begins with wp to signify the namespace, followed by the subject of our action ( "theme", "plugin", etc.) followed by the action and an optional indicator of status ( "install-success", "deleting" ).

This brings some of the theme hooks in line with the standard. As of now, all plugin actions in src/wp-admin/js/updates.js have an equal corresponding theme action.

Fixes #37598.
See #37512, #37216, #31819.
Props olarmarius, ocean90.

[jorbin]

In 38219:

Updates: Standardize JS Custom Event Names

Merges [38218] in to 4.6 branch.

Custom JS events are triggered on the document in order for plugins to have something to hook into. The standard began in #31819 is dash separated and begins with wp to signify the namespace, followed by the subject of our action ( "theme", "plugin", etc.) followed by the action and an optional indicator of status ( "install-success", "deleting" ).

This brings some of the theme hooks in line with the standard. As of now, all plugin actions in src/wp-admin/js/updates.js have an equal corresponding theme action.

Fixes #37598.
See #37512, #37216, #31819.
Props olarmarius, ocean90.