Hooks and Filters

The plugin’s public extension surface, grouped by what you’d want to do with it.

Ground Rules #

Before writing a callback:

1. Filters must return their filtered value on every path, including early bails. Returning nothing replaces the value with null for every later callback.
2. Be defensive. Don’t assume a parameter’s type; validate at the top of the callback.
3. Never log field values or full entry data. The plugin’s own records are redacted deliberately — don’t undo that in an extension.

Tuning Intervals #

// Poll every five minutes. Only worth doing if the host invokes WordPress that often.
add_filter( 'rfsfgf_worker_interval', function ( $seconds ) {
    return 300;
} );

Interval changes are detected during registration, and an event registered at the wrong interval is repaired — with the previous timestamp and interval recorded.

Shaping Schedules #

rfsfgf_next_occurrence is the hook for calendar rules the settings don’t cover — a blackout window, a business-day offset, an organisation-specific holiday list.

add_filter( 'rfsfgf_next_occurrence', function ( $target, $schedule, $after ) {
    if ( ! is_int( $target ) ) {
        return $target;
    }
    // Push a target landing on a company holiday to the next day.
    return my_is_holiday( $target ) ? $target + DAY_IN_SECONDS : $target;
}, 10, 3 );

Return a valid future timestamp. A filter that returns something unusable will produce a schedule you can’t explain from the UI.

Processing Events #

Use these for structured monitoring — a metrics pipeline, an audit trail, a dashboard.

add_action( 'rfsfgf_attempt_completed', function ( $result, $context ) {
    if ( ! is_array( $result ) ) {
        return;
    }
    my_metrics_counter( 'rfsfgf.attempt.' . rgar( $result, 'outcome', 'unknown' ) );
}, 10, 2 );

Lifecycle and Transition Events #

These are the right hooks for routing alerts somewhere other than the Admin Email — Slack, a helpdesk, a log.

add_action( 'rfsfgf_series_failed', function ( $series ) {
    if ( ! is_array( $series ) ) {
        return;
    }
    my_alerting_channel( sprintf(
        'Recurring series #%d stopped after %d consecutive failures.',
        (int) rgar( $series, 'id' ),
        (int) rgar( $series, 'consecutive_failures' )
    ) );
} );

The historical rfsfgf_auto_form_submissions_failed_entries report filter is superseded by these events. Periodic full-history email generation has been removed.

Schedule Propagation #

Useful for auditing who changed what, and for reconciling a bulk application that skipped locked series.

Diagnostics #

The plugin applies its own bounded allowlist after this filter, so you cannot use it to leak values into a report. Adding non-sensitive environment detail is the intended use.

Shortcode Visibility #

$context is overview or entry_widget. For the entry widget, $args holds the entry and form.

add_filter( 'rfsfgf_shortcode_can_view', function ( $can_view, $context, $args ) {
    if ( 'entry_widget' === $context && ! $can_view ) {
        return get_current_user_id() && (int) rgar( $args['entry'], 'created_by' ) === get_current_user_id();
    }
    return $can_view;
}, 10, 3 );

Widening the read does not widen the write. The buttons and the handler behind them still require recurring_form_submissions_manage_resubmissions.

Capability #

recurring_form_submissions_manage_resubmissions

Granted to administrators automatically. Every operational surface and handler checks it; every request also verifies its nonce and that the parent, form and feed belong together.

Gravity Forms Integration Points #

The plugin registers ordinary Gravity Forms extension points you can use as usual:

Child entries are created through normal Gravity Forms processing, so gform_after_submission and friends fire on them exactly as they would for a human submission. Use {is_auto_submission} or the entry meta to tell them apart.