groundhogg/step/enqueue/event

πŸ“… Published on

πŸ“ Last updated

Documentation

Β»

Filter Hooks

Β»

groundhogg/step/enqueue/event

Filters the event arguments array just before it is added to the event queue for a funnel step. Use this to modify the scheduled time or inject custom event arguments.

apply_filters( 'groundhogg/step/enqueue/event', $event, $contact, $step );

You will receive the event arguments array, the Contact object, and the Step object.

Example

add_filter( 'groundhogg/step/enqueue/event', 'my_extension_adjust_send_time', 10, 3 );

/**
 * Delay the event by 24 hours for contacts in a specific segment.
 *
 * @param array                $event
 * @param \Groundhogg\Contact $contact
 * @param \Groundhogg\Step    $step
 *
 * @return array
 */
function my_extension_adjust_send_time( $event, $contact, $step ) {
    if ( $contact->has_tag( MY_EXTENSION_DELAYED_TAG_ID ) ) {
        $event['time'] = $event['time'] + DAY_IN_SECONDS;
    }

    return $event;
}

Was this helpful?

Let us know if this document answered your question. That’s the only way we can improve.