Plugin lifecycle hooks

These hooks tell your code when HappenBoard and HappenBoard Pro can be used, and when they are being deleted. Use them to start a companion plugin at the right moment and to remove its data along with HappenBoard’s. Three Pro filters also change how Pro reaches its store for licences and updates. If you are new to the reference, start with Extending HappenBoard with hooks.

Load order on each request

1. WordPress loads the main file of every active plugin. Your add_action( 'happenboard_loaded', ... ) line runs here.
2. On plugins_loaded, HappenBoard attaches the hooks of all its services, then fires happenboard_loaded.
3. HappenBoard Pro answers that action at priority 10. If the free plugin is version 0.2.0 or newer, Pro attaches its own services, then fires happenboard_pro_loaded.
4. On init, HappenBoard registers its post types, taxonomies and blocks. Both plugins add new capabilities at priority 1 and update their tables at priority 2.

So inside happenboard_loaded you can use HappenBoard’s classes and filters, but its content types do not exist yet.

Uninstalling needs a constant

Deleting HappenBoard from the Plugins screen keeps all its data unless wp-config.php contains define( 'HAPPENBOARD_UNINSTALL', true );. HappenBoard Pro has its own constant, HAPPENBOARD_PRO_UNINSTALL. Each uninstall action fires only when its constant is set. Each plugin also removes only its own data: Pro’s options, its tables and the meta it keeps on WooCommerce products and orders wait for Pro’s own uninstall. The guide GDPR, personal data and uninstalling explains this to site owners.

Pro licence and updates

HappenBoard Pro activates its licence and gets its updates from the HappenBoard store (see Installing HappenBoard Pro). Its licence client and updater start on plugins_loaded on their own, outside happenboard_loaded. That way a site whose free plugin is missing or too old still receives the Pro update that fixes it. Add the three store filters from your plugin’s main file, not from a happenboard_pro_loaded callback, which does not run in that case.

do_action( 'happenboard_loaded' )

// my-happenboard-addon.php, the main file of your own plugin.
add_action(
    'happenboard_loaded',
    function (): void {
        // HappenBoard is active: its classes and filters can be used.
        add_filter( 'happenboard_schema_event', 'my_addon_schema', 10, 2 );

        // Post types and blocks are registered later, on init.
        add_action( 'init', 'my_addon_register_meta' );
    }
);

do_action( 'happenboard_pro_loaded' )

add_action(
    'happenboard_pro_loaded',
    function (): void {
        // HappenBoard and HappenBoard Pro are both active and booted.
        add_filter( 'happenboard_pro_wc_pay_later_methods', 'my_addon_pay_later', 10, 2 );

        // Pro adds its capabilities and tables on init (priorities 1 and 2):
        // read its tables from priority 3 on.
        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 ) {
        // The staging site talks to the staging store.
        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 ) {
        // Behind a slow outgoing proxy: give the store more time.
        $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 ) {
        // The store serves its downloads from a CDN.
        $hosts[] = 'downloads.example-cdn.com';

        return $hosts;
    },
    10,
    2
);

do_action( 'happenboard_uninstall' )

// In your plugin's main file, outside any HappenBoard hook.
add_action(
    'happenboard_uninstall',
    function (): void {
        global $wpdb;

        // HappenBoard has deleted nothing yet: its events are still readable.
        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' )

// In your add-on's main file, outside any HappenBoard hook.
add_action(
    'happenboard_pro_uninstall',
    function (): void {
        global $wpdb;

        // Runs once per site on multisite, with $wpdb->prefix set for that 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' );
        }
    }
);

Next steps

• GDPR, personal data and uninstalling: what deleting each plugin removes, from the site owner’s side.
• Installing HappenBoard Pro: the licence the store filters talk to.
• Admin, roles and capability hooks: choose which roles get the capabilities installed on init.