apply_filters( "llms_proccess_{$type}_engagement", boolean|WP_Error[] $can_process, int $user_id, int $template_id, string $related_id, null|int $engagement_id )

Filters whether or not an engagement should be processed immediately prior to it being sent or awarded.

Description Description

The dynamic portion of this hook, {$type} refers to the type of engagement being processed, either "email", "certificate", or "achievement".

Top ↑

Parameters Parameters


(boolean|WP_Error[]) An array of WP_Errors or true if the engagement can be processed.


(int) WP_User ID of the student earning the engagement.


(int) WP_Post ID of the template post (llms_achievement or llms_certificate).


(string) WP_Post ID of the triggering related post (course, lesson, etc...) or an empty string for user registration.


(null|int) WP_Post ID of the engagement post used to configure the trigger. A null value maybe be passed for legacy delayed engagements which were created without an engagement ID or when manually awarding via the admin UI. }

Top ↑

Source Source

File: includes/class-llms-engagement-handler.php

View on GitHub

Top ↑

Changelog Changelog

Version Description
6.0.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.