|
/ Documentation /Developer Hooks & Events/ suredonation_show_review_notice_donation Filter Hook

suredonation_show_review_notice_donation Filter Hook

Overview

The suredonation_show_review_notice_donation filter controls whether the Leave a 5-Star Review admin notice is displayed after a site receives its first live donation.

By default, the notice is enabled. Developers can use this filter to suppress the notice when it is not required for a specific website or admin workflow.

Returning false acts as a programmatic kill switch and prevents the notice from being registered.

When to Use This Filter

Use this filter when you need to control the visibility of the donation review notice.

For example, you can use it to:

  • Disable the review notice.
  • Suppress review requests on specific websites.
  • Prevent the notice from appearing for certain admin workflows.
  • Apply custom conditions before showing the notice.

Filter Signature

apply_filters( 'suredonation_show_review_notice_donation', true );

Parameters

ParameterTypeDescription
$valueboolDetermines whether the donation review notice should be displayed.

Default Value

The default value is: true

This means the review notice is enabled by default.

Return Value

Return a boolean value:

Return ValueResult
trueAllows the donation review notice to be displayed.
falseSuppresses the notice and prevents it from being registered.

Basic Usage

Use add_filter() to register a custom callback.

add_filter( 'suredonation_show_review_notice_donation', 'your_custom_function', 10, 1);

function your_custom_function( $show ) {

    return $show;

}

Example: Disable the Review Notice

The following example permanently disables the donation review notice.

// Never show the donation review notice.

add_filter(  'suredonation_show_review_notice_donation',  '__return_false');

Example: Conditionally Disable the Notice

You can also use custom logic to determine whether the notice should be displayed.

add_filter(  'suredonation_show_review_notice_donation',  'mysite_hide_donation_review_notice', 10, 1);

function mysite_hide_donation_review_notice( $show ) {

    if ( current_user_can( 'manage_options' ) ) {

        return false;

    }

    return $show;

}

How It Works

The filter is applied inside: Notices::display_review_notice_donation()

The filter determines whether SureDonation should register the donation review notice.

If the filter returns false, the notice is not registered and therefore cannot be displayed.

Additional Display Conditions

Returning true does not force the notice to appear. SureDonation also checks additional conditions before displaying it.

The donation review notice is displayed only when:

  • At least three days have elapsed since the plugin installation.
  • At least one live donation has been received.
  • The filter allows the notice to be displayed.

Related Hooks

  • suredonation_show_review_notice_gateway
  • suredonation_show_setup_gateway_notice
Was this doc helpful?
What went wrong?

We don't respond to the article feedback, we use it to improve our support content.

Need help? Contact Support
Table of Contents
Scroll to Top