tfrommen/dobby

Dobby, the friendly Admin Elf, takes care of all your (unwanted) admin notices.

v1.4.0 2021-03-16 22:32 UTC

Requires

• php: >=5.4

Requires (Dev)

• dealerdirect/phpcodesniffer-composer-installer: ^0.7.1
• phpcompatibility/php-compatibility: ^9.0
• squizlabs/php_codesniffer: ^3.5
• wp-coding-standards/wpcs: ^2.3

MIT

• Thorsten Frommen

• admin
• notices
• dobby

README

Dobby, the friendly Admin Elf, takes care of all your (unwanted) admin notices.

Installation

Install with Composer:

composer require tfrommen/dobby

Or:

1. Download ZIP.
2. Upload contents to the /wp-content/plugins/ directory on your web server.
3. Activate the plugin through the Plugins menu in WordPress.
4. See only a single admin notice, if at all.

Requirements

This plugin requires PHP 5.4 or higher, but you really should be using PHP 7 or higher, as we all know.

Usage

Dobby captures everything that gets printed on one of the admin notice hooks (i.e., network_admin_notices, user_admin_notices, admin_notices and all_admin_notices), and hides it, for now. In case Dobby did capture anything, he will inform you (yes, via an admin notice).

Filters

In order to customize certain aspects of the plugin, it provides you with several filters. For each of these, a short description as well as a code example on how to alter the default behavior is given below. Just put the according code snippet in your theme's functions.php file or your customization plugin, or to some other appropriate place.

\tfrommen\Dobby\FILTER_THRESHOLD (dobby.threshold)

This filter lets you customize the minimum number of admin notices required for Dobby to take action. The default value is 1.

Usage Example:

<?php
/**
 * Filter the minimum number of admin notices required for Dobby to take action.
 *
 * @param int $threshold Required minimum number of admin notices.
 */
add_filter( \tfrommen\Dobby\FILTER_THRESHOLD, function () {

	return 3;
} );