Plugin Notes Plus

Description

Have you ever returned to a site that you built a while back and asked, “Dude, why did I install this plugin?” This plugin provides an extra column on the Plugins page that enables you to add, edit, or delete notes about the plugins you have installed on a particular site. These notes are intended to provide documentation regarding why a particular plugin was installed and how or where it’s being used.

Features

  • Add as many or as few notes as you need for each plugin.
  • Edit or delete notes as desired.
  • Select an icon to go with each note to quickly convey what type of content it contains (e.g., info, warning, link, etc.)
  • Format notes using basic HTML tags if desired.
  • Any links included in the note will be automatically converted to target="_blank"
  • Notes are added and updated via Ajax, avoiding slow page reloads.

Installation

  1. You can either install the plugin via the Plugins directory from within your WordPress install, or you can upload the files manually to your server by extracting the .zip file and placing its contents in the /wp-content/plugins/ directory.
  2. Activate the plugin through the Plugins menu in WordPress.
  3. Add, edit, or delete notes in the Plugin Notes column on the Installed Plugins page.

FAQ

Installation Instructions
  1. You can either install the plugin via the Plugins directory from within your WordPress install, or you can upload the files manually to your server by extracting the .zip file and placing its contents in the /wp-content/plugins/ directory.
  2. Activate the plugin through the Plugins menu in WordPress.
  3. Add, edit, or delete notes in the Plugin Notes column on the Installed Plugins page.
Can I modify which icons are available to display next to plugin notes?

Yes, you can use the filter plugin-notes-plus_icon_options to modify the set of icons available. The icons must be selected from the list of available WordPress dashicons.

Here is an example of a snippet that removes one icon and adds an additional icon to the list of options. It can be added to your child theme’s functions.php:

function pnp_change_icon_options( $icon_options ) {

    // Remove key option
    unset( $icon_options['dashicons-admin-network'] );

    // Add smartphone option
    $icon_options['dashicons-smartphone'] = 'Smartphone';

    return $icon_options;
}
add_filter( 'plugin-notes-plus_icon_options', 'pnp_change_icon_options' );
Which HTML tags are permitted, and can that list be modified?

You can use the following HTML tags: a, br, p, b, strong, i, em, u, hr.

To modify the list of available tags, use the filter plugin-notes-plus_allowed_html. Be careful, however, to avoid allowing tags that could leave the site vulnerable to an XSS attack.

function pnp_change_allowed_html_tags( $allowed_tags ) {

    // Remove br from allowed tags
    unset( $allowed_tags['br'] );

    // Add img to allowed tags
    $allowed_tags['img'] = array();

    return $allowed_tags;
}
add_filter( 'plugin-notes-plus_allowed_html', 'pnp_change_allowed_html_tags' );
Where is the data stored?

Plugin notes and note metadata are stored in a custom table whose name ends in plugin_notes_plus. In the initial version (1.0.0), notes were stored in the options table. Version 1.1.0 was released to migrate existing notes from the options table into the plugin_notes_plus table. Upgrading to version 1.1.1 will perform a cleanup, removing any notes from the options table.

How does it work on multisite installs?

Each site within a multisite install maintains its own plugin notes. Additionally, the superadmin can maintain their own plugin notes.

Reviews

Great it is already there

I just thought “plugin notes would be really useful later on” in a nearly complete project and the first search result led me to your plugin. It is simple and very useful, thanks for your work!

Useful and easy!

With multiple people working on the site it’s hard to know if a plugin is something being actively used or installed by someone who is gone or just a plugin that has lost its usefulness in the scope of building the site. Plugin Notes Plus is *perfect* for what I was looking for. I no longer need to keep a seperate spreadsheet of plugin information as I can simply make notes right next to the plugin. Great work!

Very simple concept, super useful

This is so simple and yet so useful. I’m moving an old site to WordPress from a different platform and it’s been a steep learning curve, including testing out many plugin options. Keeping track of what plugins I’ve installed, and also which I’ve deactivated and why is going to be very timesaving, and it’ll help me months and years down the line too. Thank you!

Just what I needed for long-term plugin maintenance and health!

This plugin is just what I needed to comment on why a plugin is installed on a particular site. This helps future administrators (including me) know its purpose in case the plugin becomes obsolete. And it helps to avoid deleting a seemingly “unused” plugin because you don’t know or remember why it was added in the first place.

A truly useful, simple and elegant solution!

Read all 13 reviews

Contributors & Developers

“Plugin Notes Plus” is open source software. The following people have contributed to this plugin.

Contributors

“Plugin Notes Plus” has been translated into 1 locale. Thank you to the translators for their contributions.

Translate “Plugin Notes Plus” into your language.

Interested in development?

Browse the code, check out the SVN repository, or subscribe to the development log by RSS.

Changelog

1.1.0

  • Added: Cleanup routine to remove notes from the options table. (If upgrading from 1.0.0, notes will first be migrated into their own table.)

1.1.0

  • Fixed: Bug that caused plugin notes to disappear on Windows servers due to discrepancies in the plugin file path related to forward vs. backslash. This update will recover missing notes. Thanks to @gwalsh66 for helping to identify this bug.
  • Changed: Plugin notes will now be stored in a custom table called $wpdb->prefix . 'plugin_notes_plus'
  • Added: Migration routine to move notes from the options table into their own table if upgrading from version 1.0.0
  • Added: Entry in the options table called ‘plugin_notes_plus_db_version’ to track the custom database table version

1.0.0

  • Initial release