Hooks administration, rôles et permissions

Ces hooks agissent sur l’administration de HappenBoard et sur qui peut s’en servir. Ils couvrent les écrans de son menu, les données de démarrage de son application, les permissions de chaque rôle et la limite par visiteur des consultations publiques de rendez-vous. Utilisez-les pour ajouter un écran à votre module, créer un rôle sur mesure ou régler une page de réservation très fréquentée. Le guide Rôles et permissions explique chaque permission en termes simples, et Étendre HappenBoard avec les hooks présente les bases de la référence.

Comment les permissions sont accordées

HappenBoard vérifie ses propres permissions, comme happenboard_manage_events ou happenboard_view_attendees, plutôt que les rôles WordPress. L’extension gratuite et HappenBoard Pro ajoutent chacune les leurs aux rôles Administrateur et Éditeur lors de leur installation. Deux points comptent quand vous les modifiez dans le code :

• Les filtres de rôles ci-dessous ne s’exécutent qu’à l’installation des permissions : à l’activation, ou une fois après une mise à jour qui en ajoute. Ils changent ce qui est écrit à ce moment, pas ce que les rôles ont aujourd’hui.
• Les routes REST et le menu d’administration de HappenBoard laissent aussi passer tout utilisateur qui a manage_options. Retirer une permission HappenBoard aux administrateurs ne les bloque donc pas.

Rôles et permissions Pro liste les six permissions qu’ajoute HappenBoard Pro.

apply_filters( 'happenboard_admin_submenus', array $default )

add_filter(
    'happenboard_admin_submenus',
    function ( $submenus ) {
        // Ajoutez à la liste : renvoyer un nouveau tableau ferait disparaître
        // les écrans intégrés et ceux qu'ajoute HappenBoard Pro.
        $submenus[] = array(
            'path'       => 'options-general.php?page=my-addon',
            'label'      => __( 'My add-on', 'my-addon' ),
            'capability' => 'manage_options',
            'parent'     => '',
            'external'   => true, // Une page d'admin classique, pas une route de l'appli.
        );

        return $submenus;
    },
    20
);

apply_filters( 'happenboard_screen_context', array $context )

add_filter(
    'happenboard_screen_context',
    function ( $context ) {
        // Vos réglages, imbriqués pour que les booléens restent booléens en JS.
        $context['myAddon'] = array(
            'enabled'  => true,
            'endpoint' => rest_url( 'my-addon/v1/' ),
        );

        return $context;
    },
    20
);

apply_filters( 'happenboard_capabilities_role_defaults', array $mapping )

// Dans une extension MU ou le fichier principal de votre extension, avant init.
add_filter(
    'happenboard_capabilities_role_defaults',
    function ( $mapping ) {
        // Les gérants de boutique WooCommerce voient participants et rendez-vous.
        $mapping['shop_manager'] = array(
            'happenboard_view_attendees',
            'happenboard_view_bookings',
        );

        return $mapping;
    }
);
// Puis désactivez et réactivez HappenBoard une fois pour l'appliquer.

apply_filters( 'happenboard_pro_capabilities_role_defaults', array $mapping )

add_filter(
    'happenboard_pro_capabilities_role_defaults',
    function ( $mapping ) {
        // Les gérants de boutique WooCommerce gèrent commandes et remboursements.
        $mapping['shop_manager'] = array(
            'happenboard_view_orders',
            'happenboard_export_orders',
            'happenboard_refund_orders',
        );

        return $mapping;
    }
);
// Puis désactivez et réactivez HappenBoard Pro une fois pour l'appliquer.

apply_filters( 'happenboard_me_capabilities', array $caps, WP_User $user )

add_filter(
    'happenboard_me_capabilities',
    function ( $caps, $user ) {
        // Un front end sur mesure a aussi besoin des permissions de rendez-vous.
        $extra = array( 'happenboard_view_bookings', 'happenboard_manage_booking_types', 'happenboard_host' );

        foreach ( $extra as $cap ) {
            $caps[ $cap ] = user_can( $user, $cap );
        }

        return $caps;
    },
    10,
    2
);

apply_filters( 'happenboard_throttle_public_reads', bool $counts )

add_filter(
    'happenboard_throttle_public_reads',
    function ( $counts ) {
        // Pas de Redis ni de Memcached ici, mais un robot aspire la page de
        // réservation : comptez quand même les consultations.
        return true;
    }
);

Pour aller plus loin

• Rôles et permissions : ce que permet chaque permission gratuite.
• Rôles et permissions Pro : les permissions des billets, commandes, check-in et ressources.
• happenboard_booking_client_ip : donner à la limite des consultations la vraie adresse du visiteur derrière un proxy.