README

WordPress helper for showing a dismissible "please review" admin notice after a plugin or theme has been in use for a number of days.

Installation

composer require ernilambar/wp-admin-notice

Requirements

WP 6.0+
PHP 7.2+

Usage

Call Notice::init() on admin_init. slug must match the WordPress.org plugin or theme slug, since it builds the review URL.

use Nilambar\AdminNotice\Notice;

add_action( 'admin_init', function () {
	Notice::init(
		[
			'slug' => 'my-plugin',
			'name' => 'My Plugin',
		]
	);
} );

Advanced usage

The defaults are plain English. To translate them, copy this block and swap my-plugin for your text domain:

use Nilambar\AdminNotice\Notice;

add_action( 'admin_init', function () {
	Notice::init(
		[
			'slug'          => 'my-plugin',
			'name'          => 'My Plugin',
			'type'          => 'plugin',
			'days'          => 7,
			'capability'    => 'manage_options',
			'screens'       => [],
			'classes'       => [],
			'message'       => sprintf(
				/* translators: 1: Name, 2: Days. */
				esc_html__( 'Hello! Seems like you have been using %1$s for more than %2$d days - that\'s awesome! Could you please do us a BIG favor and give it a 5-star rating on WordPress? This would boost our motivation and help us spread the word.', 'my-plugin' ),
				'<strong>My Plugin</strong>',
				7
			),
			'action_labels' => [
				'review'  => esc_html__( 'Ok, you deserve it', 'my-plugin' ),
				'later'   => esc_html__( 'Nope, maybe later', 'my-plugin' ),
				'dismiss' => esc_html__( 'I already did', 'my-plugin' ),
			],
		]
	);
} );

Strings placed in your plugin or theme this way are picked up by wp i18n make-pot and translated through your normal workflow.

Arguments

Key	Type	Default	Description
`slug`	string	—	Required. WordPress.org slug. Also prefixes option keys and hook names. Missing or empty returns `null`.
`name`	string	Title-cased `slug`	Name used in the default message.
`type`	string	`plugin`	`plugin` or `theme`; anything else falls back to `plugin`.
`days`	int	`7`	Days before showing, and the delay added by "maybe later".
`capability`	string	`manage_options`	Capability needed to see and dismiss.
`screens`	array	`[]`	Screen IDs to limit to. Empty shows everywhere.
`classes`	array	`[]`	Extra CSS classes. `notice notice-info` is always applied.
`action_labels`	array	`review`, `later`, `dismiss`	Link labels. Empty string hides that link.
`message`	string	Built-in text	Notice body. Echoed unescaped — escape it yourself. Empty hides the notice.

License

This project is licensed under the MIT.

ernilambar / wp-admin-notice

Maintainers

Package info

Statistics

Security