Skip to main content

benecaster_get_notify_referral_updates()

Utilities Free
benecaster_get_notify_referral_updates(): bool

Reads the podcaster’s answer to Email me when referral credits are earned or applied on the Refer a Friend page. Use it before an add-on sends its own notification about referral activity, so your message honours the same choice.

It reads a locally cached value and makes no HTTP call. The value is written only from the licence server’s answers, and it survives a lapsed licence or a disconnected show. LicenseManager::get_cached_notify_referral_updates() returns the same setting as ?bool, with null meaning nothing has been answered yet.

Read-only. The emails are sent by the licence server, not by the plugin, so an add-on cannot change the preference by writing the option. Only the checkbox reaches the server.

Return Value

Type: bool

Whether the podcaster wants Benecaster's referral-credit emails. true when they have not answered yet, which matches the licence server's own default.

Example

if ( benecaster_get_notify_referral_updates() ) {
    // The podcaster wants to hear about referral activity.
    my_addon_send_referral_digest();
}

Need this built rather than just documented? See our services →