Hook/Acțiune pentru Actualizare Plugin WordPress? De la versiunea 3.9

Începând cu WordPress 3.9, poți utiliza hook-ul upgrader_process_complete.
Acest hook va fi declanșat atunci când procesul de actualizare este finalizat (plugin-urile și temele sunt actualizate).

Vezi referințele 1, 2, 3

Iată un exemplu de cod:

<?php 
/**
 * Plugin Name: Test plugin 1
 * Plugin URI: https://rundiz.com
 * Description: Un plugin foarte simplu pentru testare. Acest plugin nu face nimic.
 * Version: 0.1.8
 * Author: Vee Winch
 * Author URI: http://rundiz.com
 * License: MIT
 * License URI: https://opensource.org/licenses/MIT
 * Text Domain: test-plugin1
 * Domain Path: 
 */


add_action('upgrader_process_complete', 'testplugin_upgrade_completed', 10, 2);
/**
 * Procesul de actualizare completat.
 *
 * @see \WP_Upgrader::run() (wp-admin/includes/class-wp-upgrader.php)
 * @param \WP_Upgrader $upgrader_object
 * @param array $hook_extra
 */
function testplugin_upgrade_completed(\WP_Upgrader $upgrader_object, $hook_extra)
{
    // obține versiunea curentă a plugin-ului. ( https://wordpress.stackexchange.com/a/18270/41315 )
    if(!function_exists('get_plugin_data')){
        require_once(ABSPATH . 'wp-admin/includes/plugin.php');
    }
    // https://developer.wordpress.org/reference/functions/get_plugin_data/
    $plugin_data = get_plugin_data(__FILE__);
    $plugin_version = ($plugin_data['Version'] ?? 'unknown.version');
    unset($plugin_data);

    if (
        is_array($hook_extra) && 
        array_key_exists('action', $hook_extra) && 
        $hook_extra['action'] == 'update'
    ) {
        if (
            array_key_exists('type', $hook_extra) && 
            $hook_extra['type'] == 'plugin'
        ) {
            // dacă plugin-urile au fost actualizate.
            $this_plugin = plugin_basename(__FILE__);
            $this_plugin_updated = false;
            if (array_key_exists('plugins', $hook_extra)) {
                // dacă actualizarea în masă a plugin-urilor (în pagina de actualizare)
                foreach ($hook_extra['plugins'] as $each_plugin) {
                    if ($each_plugin === $this_plugin) {
                        $this_plugin_updated = true;
                        break;
                    }
                }// endforeach;
                unset($each_plugin);
            } elseif (array_key_exists('plugin', $hook_extra)) {
                // dacă actualizarea normală a plugin-ului sau prin actualizare automată.
                if ($this_plugin === $hook_extra['plugin']) {
                    $this_plugin_updated = true;
                }
            }
            if ($this_plugin_updated === true) {
                // dacă acest plugin tocmai a fost actualizat.
                // efectuează-ți sarcinile aici.
                // NU procesa nimic din noua versiune de cod aici, deoarece va funcționa pe versiunea veche a plugin-ului.
                // citește din nou!! codul rulat aici nu este noua versiune (tocmai actualizată) ci versiunea anterioară.
                file_put_contents(WP_CONTENT_DIR . '/test.txt', 'v'.$plugin_version."\r\n", FILE_APPEND);
                // setează transient pentru a-l rula mai târziu.
                set_transient('testplugin_just_updated', 1);
            }
        } elseif (
            array_key_exists('type', $hook_extra) && 
            $hook_extra['type'] == 'theme'
        ) {
            // dacă temele au fost actualizate.
            // la fel ca la plugin, actualizarea în masă a temelor va fi setată în $hook_extra['themes'] ca 'theme1', 'theme2'.
            // actualizarea normală sau prin actualizare automată va fi setată în $hook_extra['theme'] ca 'theme1'.
        }
    }// endif; $hook_extra
}// testplugin_upgrade_completed


add_action('plugins_loaded', 'testplugin_pluginloaded');
/**
 * Rulează odată ce plugin-ul este încărcat (la fiecare încărcare de pagină).
 */
function testplugin_pluginloaded()
{
    // obține versiunea curentă a plugin-ului. ( https://wordpress.stackexchange.com/a/18270/41315 )
    if(!function_exists('get_plugin_data')){
        require_once(ABSPATH . 'wp-admin/includes/plugin.php');
    }
    // https://developer.wordpress.org/reference/functions/get_plugin_data/
    $plugin_data = get_plugin_data(__FILE__);
    $plugin_version = ($plugin_data['Version'] ?? 'unknown.version');
    unset($plugin_data);

    if (get_transient('testplugin_just_updated') && current_user_can('manage_options')) {
        // dacă a fost marcat în transient că acest plugin tocmai a fost actualizat și utilizatorul curent este administrator.
        // poți folosi noua versiune de cod aici.
        file_put_contents(WP_CONTENT_DIR . '/test-update-by-transient.txt', 'v'.$plugin_version."\r\n", FILE_APPEND);

        // codul tău de actualizare aici.
        
        // șterge transient-ul când este gata pentru a nu permite rularea acestui cod din nou.
        delete_transient('testplugin_just_updated');
    }
}// testplugin_pluginloaded

Hook-ul upgrader_process_complete va rula cu versiunea curentă de cod în timp ce plugin-ul/tema este actualizată. Nu folosește noua versiune.

Scenariu

1. Ai plugin-ul versiunea 1.0
2. Rulezi pagina de actualizare sau actualizarea automată.
3. Plugin-ul tău versiunea 2.0 va fi descărcat și extras. Hook-ul upgrader_process_complete va fi apelat.
4. Plugin-ul tău versiunea 1.0 va rula în hook-ul upgrader_process_complete.
5. Odată finalizat, reîncarcă pagina și hook-ul plugins_loaded va fi apelat.
6. Plugin-ul tău versiunea 2.0 rulează în hook-ul plugins_loaded. (Plugin-ul trebuie să fie activat.)

Acestea au fost deja explicate în codul postat anterior (înainte de editare), dar poate nu suficient de clar sau greu de observat.

Hook-ul upgrader_process_complete este creat pentru aceasta (te rog citește în link-ul de referință 3). Pentru a rula după ce actualizarea este finalizată.

Poți folosi hook-ul plugins_loaded cu codul din răspunsul acceptat. A funcționat și este mai scurt sau poți avea o idee mai bună de utilizat cu hook-ul upgrader_process_complete.

Hook-ul upgrader_process_complete va funcționa când:

1. Actualizezi prin pagina de actualizare.
2. Actualizezi prin pagina de plugin-uri sau teme.
3. Actualizezi prin actualizare automată sau WP Cron.

Codul de mai sus nu funcționează când actualizezi plugin-ul sau tema prin FTP deoarece nu poate detecta opțiunea transient. În acest caz, răspunsul acceptat este singura opțiune bună pentru tine.

Din discuția în care s-a decis să nu se adauge un hook/funcție personalizat specific pentru actualizare, reiese că "majoritatea oamenilor" (acum 4 ani) folosesc register_activation_hook, deoarece este apelat atunci când un plugin este actualizat prin pagina de administrare; majoritatea exemplelor pe care le-am văzut de atunci urmează această tendință.

Pentru majoritatea cazurilor de utilizare, aș sugera să nu folosiți hook-ul prin plugins_loaded, deoarece ar fi apelat la fiecare încărcare de pagină. Excepția de la această regulă este menționată în discuție: căile de actualizare prin FTP/SVN sunt 'cazuri marginale', deoarece WordPress nu ar avea un mecanism pentru a ști că plugin-ul a fost modificat, caz în care răspunsul anterior ar putea fi mai relevant.

Consultați https://gist.github.com/zaus/c08288c68b7f487193d1 pentru un exemplu de 'cadru simplu' folosind register_activation_hook.

În timp ce căutam ceva similar în noiembrie 2023, am decis să împărtășesc această sugestie: filtrul update_plugins_{$hostname} a fost introdus în WordPress începând cu versiunea 5.8.0.

Această funcționalitate funcționează doar dacă plugin-ul utilizează antetul Update URI. Deci, dacă dezvolți un plugin, poți include antetul Update URI în partea de sus a fișierului principal, cu valoarea fiind endpoint-ul tău JSON. Apoi, vei folosi filtrul înlocuind {hostname} cu numele de gazdă al acelui URL. De exemplu, să presupunem că acesta este fișierul meu de plugin personalizat, situat în /wp-content/plugins/my-custom-plugin/my-custom-plugin.php, iar în partea de sus am:

/**
 * Plugin Name: My Custom Plugin
 * Version: 1.0.0
 * Author: AuRise Creative
 * Update URI: https://aurisecreative.com/update-my-custom-plugin/
 */

Acum aș putea folosi acest filtru pentru a verifica actualizările plugin-ului și a prelua datele de actualizare (dacă există) pentru acel plugin.

/**
 * Verifică actualizările pentru plugin
 *
 * @param array|false $update Datele de actualizare ale plugin-ului cu cele mai recente detalii. Valoare implicită false.
 * @param array $plugin_data Antetele plugin-ului.
 * @param string $plugin_file Numele fișierului plugin-ului.
 * @param string $locales Locale instalate pentru căutarea traducerilor.
 *
 * @return array|false Un array asociativ cu datele de actualizare în caz de succes. False în caz contrar.
 */
function prefix_check_for_plugin_updates($update, $plugin_data, $plugin_file, $locales = '')
{
    // Efectuează operații
    return $update;
}
add_filter('update_plugins_aurisecreative.com', 'prefix_check_for_plugin_updates', 10, 4);

Din păcate, această funcționalitate funcționează doar pentru plugin-urile care utilizează acest antet, deci cel mai probabil pentru plugin-urile premium.

Surse:

• Documentația pentru dezvoltatori despre filtrul update_plugins_{hostname}
• Câmpurile antetelor plugin-urilor
• Anunțul despre antetul "Update URI" în WordPress 5.8 publicat pe 29 iunie 2021

Puteți interveni în filtrele upgrader_pre_install și upgrader_post_install.