Hooks cycle de vie de l’extension

Ces hooks indiquent à votre code quand HappenBoard et HappenBoard Pro sont prêts, et quand ils sont supprimés. Servez-vous-en pour démarrer une extension compagnon au bon moment et pour effacer ses données en même temps que celles de HappenBoard. Trois filtres Pro modifient aussi la façon dont Pro contacte sa boutique pour la licence et les mises à jour. Si vous débutez avec la référence, commencez par Étendre HappenBoard avec les hooks.

L’ordre de chargement à chaque requête

1. WordPress charge le fichier principal de chaque extension active. Votre ligne add_action( 'happenboard_loaded', ... ) s’exécute à ce moment.
2. Sur plugins_loaded, HappenBoard branche les hooks de tous ses services, puis déclenche happenboard_loaded.
3. HappenBoard Pro répond à cette action en priorité 10. Si l’extension gratuite est en version 0.2.0 ou plus, Pro branche ses propres services, puis déclenche happenboard_pro_loaded.
4. Sur init, HappenBoard enregistre ses types de contenu, taxonomies et blocs. Les deux extensions ajoutent leurs nouvelles permissions en priorité 1 et mettent à jour leurs tables en priorité 2.

Dans happenboard_loaded, vous pouvez donc utiliser les classes et les filtres de HappenBoard, mais ses types de contenu n’existent pas encore.

La désinstallation demande une constante

Supprimer HappenBoard depuis l’écran Extensions conserve toutes ses données, sauf si wp-config.php contient define( 'HAPPENBOARD_UNINSTALL', true );. HappenBoard Pro a sa propre constante, HAPPENBOARD_PRO_UNINSTALL. Chaque action de désinstallation ne se déclenche que si sa constante est définie. Chaque extension ne supprime aussi que ses propres données : les options et tables de Pro, et les métadonnées qu’il garde sur les produits et commandes WooCommerce, attendent la désinstallation de Pro. Le guide RGPD, données personnelles et désinstallation l’explique aux propriétaires de sites.

Licence et mises à jour de Pro

HappenBoard Pro active sa licence et récupère ses mises à jour auprès de la boutique HappenBoard (voir Installer HappenBoard Pro). Son client de licence et son module de mise à jour démarrent seuls sur plugins_loaded, en dehors de happenboard_loaded. Ainsi, un site dont l’extension gratuite manque ou est trop ancienne reçoit quand même la mise à jour de Pro qui règle le problème. Ajoutez les trois filtres de boutique depuis le fichier principal de votre extension, pas depuis une fonction sur happenboard_pro_loaded, qui ne s’exécute pas dans ce cas.

do_action( 'happenboard_loaded' )

// my-happenboard-addon.php, le fichier principal de votre extension.
add_action(
    'happenboard_loaded',
    function (): void {
        // HappenBoard est actif : ses classes et ses filtres sont utilisables.
        add_filter( 'happenboard_schema_event', 'my_addon_schema', 10, 2 );

        // Les types de contenu et les blocs sont enregistrés plus tard, sur init.
        add_action( 'init', 'my_addon_register_meta' );
    }
);

do_action( 'happenboard_pro_loaded' )

add_action(
    'happenboard_pro_loaded',
    function (): void {
        // HappenBoard et HappenBoard Pro sont tous deux actifs et démarrés.
        add_filter( 'happenboard_pro_wc_pay_later_methods', 'my_addon_pay_later', 10, 2 );

        // Pro ajoute ses permissions et ses tables sur init (priorités 1 et 2) :
        // lisez ses tables à partir de la priorité 3.
        add_action( 'init', 'my_addon_load_ticket_stats', 5 );
    }
);

apply_filters( 'happenboard_pro_store_url', string $store )

add_filter(
    'happenboard_pro_store_url',
    function ( $store ) {
        // Le site de préproduction dialogue avec la boutique de préproduction.
        if ( 'staging' === wp_get_environment_type() ) {
            return 'https://staging-store.example.com/';
        }

        return $store;
    }
);

apply_filters( 'happenboard_pro_licence_request_args', array $args, string $action, string $url )

add_filter(
    'happenboard_pro_licence_request_args',
    function ( $args, $action, $url ) {
        // Derrière un proxy sortant lent : laissez plus de temps à la boutique.
        $args['timeout'] = 30;

        return $args;
    },
    10,
    3
);

apply_filters( 'happenboard_pro_update_package_hosts', array $hosts, string $url )

add_filter(
    'happenboard_pro_update_package_hosts',
    function ( $hosts, $url ) {
        // La boutique sert ses téléchargements depuis un CDN.
        $hosts[] = 'downloads.example-cdn.com';

        return $hosts;
    },
    10,
    2
);

do_action( 'happenboard_uninstall' )

// Dans le fichier principal de votre extension, hors de tout hook HappenBoard.
add_action(
    'happenboard_uninstall',
    function (): void {
        global $wpdb;

        // HappenBoard n'a encore rien supprimé : ses événements sont lisibles.
        delete_option( 'my_addon_settings' );
        $wpdb->query( "DROP TABLE IF EXISTS {$wpdb->prefix}my_addon_log" );
        wp_clear_scheduled_hook( 'my_addon_cron' );

        foreach ( wp_roles()->role_objects as $role ) {
            $role->remove_cap( 'my_addon_manage' );
        }
    }
);

do_action( 'happenboard_pro_uninstall' )

// Dans le fichier principal de votre module, hors de tout hook HappenBoard.
add_action(
    'happenboard_pro_uninstall',
    function (): void {
        global $wpdb;

        // Une fois par site en multisite, avec $wpdb->prefix réglé pour ce site.
        delete_option( 'my_addon_ticket_report' );
        $wpdb->query( "DROP TABLE IF EXISTS {$wpdb->prefix}my_addon_sales" );

        foreach ( wp_roles()->role_objects as $role ) {
            $role->remove_cap( 'my_addon_view_sales' );
        }
    }
);

Pour aller plus loin

• RGPD, données personnelles et désinstallation : ce que la suppression de chaque extension efface, côté propriétaire du site.
• Installer HappenBoard Pro : la licence avec laquelle dialoguent les filtres de boutique.
• Hooks administration, rôles et permissions : choisir quels rôles reçoivent les permissions installées sur init.