Plugin Notes Plus

Omschrijving

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.
  • Notes also display on the WordPress Updates page for any plugins that need to be updated.

Schermafdrukken

  • Upon activating the plugin, you will see a new column on the Plugins page that enables you to add, edit, or delete notes about the plugins you have installed on a particular site.

Installatie

  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

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.

Beoordelingen

30 augustus 2020
Especially when administrating several WP blogs, it's easy to lose track of what plugin is where for what reason. And what was the name of the plugin that actually did a stellar job at what I wanted it to do? And why is this seemingly needless set-and-forget plugin integral for the overall function of the site? This plugin adds a column to the admin area so you can directly add a note onto the plugin list to say why is this annoying-looking thingamabob here cluttering up my plugin list... and why you can't delete it even though it looks annoying. 😀
8 juli 2020
Don['t be scared. Just because it has not been updated lately does not mean a plugin does not work. This is a fantastic plugin to help you keep track of what each plugin is for and who installed it. Can also keep licence details in the notes. This plugin along with LH Dashnotes plugin are a great way to document your site.
12 maart 2020
We all have WordPress websites with too many plug-ins. This plug-in helps you to understand which plug-in does what. Very basic – but extremely helpful. And beautifully made.
4 maart 2020
Hi Jamie! I once had an issue with Plugin Notes Plus — you even replied via email and I never really followed that up. Please excuse — but the issue disappeared in the backend of one of my projects and probably vanished after a fresh install. 🙂 Using Plugin Notes Plus for quite a while in several WP installations (this is so very helpful, Jamie!) I find myself keying in the same notes for the same plugins several times. Thinking about Bigue Nique's suggestion in his or her review I felt motivated to add this here: I wish there was an easy way to "share" some basic and general information for a plugin between different WP projects. A big dream I guess? Cheers, Frank
29 februari 2020
This is a required functionnality to ease the maintenance of any site that relies on plugins for specific uses. We all thought of such plugin, and someone actually did it. And it's well done. This should definitely be built-in into WordPress. Works with multisite (where it becomes VERY useful!). Notes are specific to each site. Notes added to network plugins page are assigned to the main site. Suggestion: permit network-wide notes (that would show for every site).
Lees alle 32 beoordelingen

Bijdragers & ontwikkelaars

“Plugin Notes Plus” is open source software. De volgende personen hebben bijgedragen aan deze plugin.

Bijdragers

“Plugin Notes Plus” is vertaald in 5 talen. Dank voor de vertalers voor hun bijdragen.

Vertaal “Plugin Notes Plus” naar jouw taal.

Interesse in ontwikkeling?

Bekijk de code, haal de SVN repository op, of abonneer je op het ontwikkellog via RSS.

Changelog

1.2.2

  • Added: Updates for RTL compatibility. Thanks to @ramiy.
  • Removed: Unnecessary po and mo translation files.

1.2.1

  • Fixed: JavaScript error that sometimes happened on update-core.php if a plugin had no notes. Thanks to @brianhenryie for bringing this to my attention.
  • Added: Hungarian translation. Thanks to @tomek00.

1.2.0

  • Added: Plugin notes now display in a read-only format on the WordPress Updates page (update-core.php). Thanks to @douglsmith for the suggestion.
  • Fixed: Removed unnecessary multisite hook. Thanks to @foomagoo for pointing this out.

1.1.2

  • Fixed: Bug that prevented user from adding or updating notes after an ajax response. Thanks to @anticosti for helping to identify this bug.
  • Added: Spinning icon to indicate that a note is in the process of being deleted.

1.1.1

  • 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