README

An helper library to create persistent and dismissible WordPress admin notices.

Notices created using this method are automatically dismissible.

Usage

$my_notices = new \Pressmodo\AdminNotices\Notices();

// Add a notice.
$my_notices->add( (string) $id, (string) $title, (string) $content, (array) $options );

// Boot things up.
$my_notices->boot();

After you instantiate the Notices object using $my_notices = new \Pressmodo\AdminNotices\Notices(); you can add new notices using the add() method.

The arguments of this method are:

The $options argument is an array that can have the following optional items:

Examples

You can add the following code within your theme's existing code.

First we need to instantiate the Notices object:

use Pressmodo\AdminNotices\Notices;

$my_notices = new Notices();

To add a simple, default notice:

$my_notices->add(
    'my_theme_notice',                           // Unique ID.
    esc_html__( 'Notice Title', 'textdomain' ),  // The title for this notice.
    esc_html__( 'Notice content', 'textdomain' ) // The content for this notice.
);

The above example will create a new notice that will only show on all dashboard pages. When the notice gets dismissed, a new option will be saved in the database with the key pressmodo_notice_dismissed_my_theme_notice. The key gets created by appending the $id to the default prefix for the option (pressmodo_notice_dismissed), separated by an underscore.

To add a more customized notice:

$my_notices->add(
    'my_notice',                                  // Unique ID.
    esc_html__( 'Notice Title', 'textdomain' ),   // The title for this notice.
    esc_html__( 'Notice content', 'textdomain' ), // The content for this notice.
    [
        'scope'         => 'user',       // Dismiss is per-user instead of global.
        'screens'       => [ 'themes' ], // Only show notice in the "themes" screen.
        'type'          => 'warning',    // Make this a warning (orange color).
        'alt_style'     => true,         // Use alt styles.
        'option_prefix' => 'my_theme',   // Change the user-meta prefix.
    ]
);

The above example will create a new notice that will only show in the "Themes" screen in the dashboard. When the notice gets dismissed, a new user-meta will be saved and the key for the stored user-meta will be my_theme_my_notice. The key gets created by appending the $id to our defined option_prefix, separated by an underscore.

The Notices class can be used to add multiple notices. Once you have finished adding the notices, you will have to run the boot method so that the notices can be added to the dashboard:

$my_notices->boot();

To sum up all the above, a complete example of how to add an admin notice would look like this:

$my_notices = new \Pressmodo\AdminNotices\Notices();
$my_notices->add( 'my_theme_notice', __( 'Title', 'textdomain' ), __( 'Content', 'textdomain' ) );
$my_notices->boot();

Autoloading

You'll need to use an autoloader with this. Ideally, this would be Composer.

Composer

From the command line:

composer require pressmodo/wp-admin-notices

pressmodo / wp-admin-notices

Maintainers

Details

README

Usage

Examples

Autoloading

Composer