Title: Plugin Notes
Author: Mohammad Jangda
Published: octobre 25, 2009
Last modified: juillet 16, 2015
---
Search plugins
This plugin **hasn’t been tested with the latest 3 major releases of WordPress**.
It may no longer be maintained or supported and may have compatibility issues when
used with more recent versions of WordPress.
# Plugin Notes
By [Mohammad Jangda](https://profiles.wordpress.org/batmoo/)
[Download](https://downloads.wordpress.org/plugin/plugin-notes.1.6.zip)
* [Details](https://tah.wordpress.org/plugins/plugin-notes/#description)
* [Reviews](https://tah.wordpress.org/plugins/plugin-notes/#reviews)
* [Installation](https://tah.wordpress.org/plugins/plugin-notes/#installation)
* [Development](https://tah.wordpress.org/plugins/plugin-notes/#developers)
[Support](https://wordpress.org/support/plugin/plugin-notes/)
## Description
Allows you to add notes to plugins. Useful when you’re using lots of plugins and/
or make modifications to a plugin and want to make a note of them, and/or work on
your WordPress install with a group of people. This plugin was inspired by a post
by [Chris Coyier](http://digwp.com): (http://digwp.com/2009/10/ideas-for-plugins/)
#### Features
* Add/edit/delete notes for each plugin on the plugin page
* You can use HTML in notes (v1.1+)
* You can use [markdown syntax](http://daringfireball.net/projects/markdown/syntax)
in notes (v1.5+)
* You can use a number of variables which will be automagically replaced when the
note displays (v1.5+)
* Save a note as a template for new notes (v1.5+)
* You can color-code notes to see in one glance what’s up or down (v1.6+)
* Links within note automagically have `target="_blank"` added so you won’t accidently
leave your site while working with the plugins.
Please have a look at the [FAQ](https://wordpress.org/plugins/plugin-notes/faq/)
for more information about these features.
#### Credits
**Markdown script**: [PHP Markdown 1.0.1.o](http://michelf.ca/projects/php-markdown/)
**External link indicator**: liberally nicked from the [Better WP External Links](https://wordpress.org/plugins/bwp-external-links/)
plugin
#### Translations
Dutch – [jrf](https://wordpress.org/support/profile/jrf)
Please help us make this plugin available in more language by translating it. See
the [FAQ](https://wordpress.org/plugins/plugin-notes/faq/) for more info.
## Screenshots
* [[
* Easily add/edit/delete note or save as notes-template. Uses AJAX so you’ll save
at least a couple seconds for each note you add/edit/delete.
* [[
* Example of saved note using markdown syntax and variable replacement.
* [[
* A bunch of multi-coloured notes added to plugins.
## Installation
1. Extract the .zip file and upload its contents to the `/wp-content/plugins/` directory.
Alternately, you can install directly from the Plugin directory within your WordPress
Install.
2. Activate the plugin through the « Plugins » menu in WordPress.
3. Add notes to your plugins from the Manage Plugins page (Plugins > Installed)
4. Party.
## FAQ
Where is the Plugin Notes data stored?
The notes are stored in the options table of the database.
Which variables can I use ?
There are a number of variables you can use in the notes which will automagically
be replaced. Most aren’t that useful as the info is provided by default for the
plugin, but they are included anyway for completeness.
Example use: you want a link to the WordPress Plugin repository for each plugin.
Instead of manually adding each and every link, you can just add the following note
to each plugin and the link will be automagically placed:
```
Plugin: %WPURI_LINK%
```
**Available variables**:
%PLUGIN_PATH% : Plugin uri path on your website %WPURI%:
URI of the WordPress repository of the plugin (Please note: it is not tested whether
the plugin is actually registered in the WP plugin repository!) %WPURI_LINK% : A
link to the above WordPress repository of the plugin
**Already showing for each plugin (less useful)**:
%NAME%: Plugin Name %URI%: URI
of the plugin website %AUTHOR%: Name of the plugin author %AUTHORURI%: Website of
the plugin author %VERSION%: Current plugin version %DESCRIPTION%: Description of
the plugin
Can I use the markdown syntax in the notes ?
Yes, you can use markdown.
The markdown syntax conversion is done on the fly. The
notes are saved to the database without conversion.
Don’t like markdown ?
Just add the following snippet to your (child-)themes functions.
php file to turn markdown parsing off: add_filter( ‘plugin_notes_markdown’, ‘__return_false’);
How do I use Markdown syntax?
Please refer to [markdown syntax](http://daringfireball.net/projects/markdown/syntax).
Can I use html in the notes ?
Yes, you can use html in the notes. The following tags are allowed: `a, br, p, b,
strong, i, em, u, img, hr`.
The html is saved to the database with the note.
Can I change the allowed html tags ?
Yes, you can, though be careful as you might open up your WP install to XSS attacks.
To change the allowed html tags, just add a variation of the following snippet to
your (child-)themes functions.php file:
add_filter( ‘plugin_notes_allowed_tags’,‘
your_function’, 10, 1 ); function your_function( $allowed_tags ) { //do something
with the $allowed_tags array return $allowed_tags; }
Can I change the output of the plugin ?
Yes, you can. There are filters provided at three points:
1. The actual note to
be displayed -> `plugin_notes_note` 1. The html for the note including the surrounding
box -> `plugin_notes_row` 1. The html for the input form -> `plugin_notes_form`
Hook into those filters to change the output before it’s send to the screen.
```
add_filter( 'plugin_notes_note', 'your_function', 10, 3 );
function your_function( $note, $plugin_data, $plugin_file ) {
//do something
return $output;
}
add_filter( 'plugin_notes_row', 'your_function', 10, 3 );
function your_function( $output, $plugin_data, $plugin_file ) {
//do something
return $output;
}
add_filter( 'plugin_notes_form', 'your_function', 10, 2 );
function your_function( $output, $plugin_safe_name ) {
//do something
return $output;
}
```
If you want to filter the note output before the variable replacements are made
and markdown syntax is applied, set the priority for your `plugin_notes_note` filter
to lower than 10.
Example:
add_filter( ‘plugin_notes_note’, ‘your_function’, 8, 3 );
How can I translate the plugin?
The plugin is translation ready, though there is not much to translate. Use the `/
languages/plugin-notes.pot` file to create a new .po file for your language. If
you would like to offer your translation to other users, please [open a pull request on GitHub](https://github.com/mjangda/plugin-notes).
## Reviews
### [Highly recommended](https://wordpress.org/support/topic/highly-recommended-254/)
[Pedro Magnifico](https://profiles.wordpress.org/pedro-magnifico/) avril 12, 2018
Works great. I use it in all of my website projects to remind myself of important
details of plugins where needed.
### [Amazing!](https://wordpress.org/support/topic/amazing-1718/)
[pesseba](https://profiles.wordpress.org/pesseba/) février 22, 2018
This plugin help to remember why the plugin is usefull, if there is some personal
customization, activation keys, etc…
### [Very useful plugin!](https://wordpress.org/support/topic/very-useful-plugin-509/)
[abooster](https://profiles.wordpress.org/abooster/) mai 22, 2017
This is a life-saver plugin for me! Thanks a lot!
### [Great Plugin](https://wordpress.org/support/topic/great-plugin-13809/)
[Frank Shrum](https://profiles.wordpress.org/frankshrum/) mai 10, 2017
I really love this plugin. I started using it years ago and before I stopped working
with WordPress then when I returned to it one of the 1st plugins I went searching
for is this one. I actually put a note in this note that says, « This plugin DO
NOT REMOVE! » for me so I will not accidentally delete it. Yea, I did that once
and liked to never found it again. It sure would be great if the creators had a
version that can put notes on other areas of WP or, maybe, they will create a residual
note that would be retained on every page of WP. Sometimes a not to my staff to
use particular shortcodes or etc. would be great where I make the note then instruct
everyone to always take a look there every time they post or edit inside WP to use
codes or information I need them to do.
### [Very simple and efficient.](https://wordpress.org/support/topic/very-simple-and-efficient-2/)
[andre2009](https://profiles.wordpress.org/andre2009/) mars 10, 2017
Do what is necessary, and does it very well. Thank you.
### [Simple & useful](https://wordpress.org/support/topic/simple-useful-24/)
[Martin Sauter](https://profiles.wordpress.org/martinsauter/) mars 6, 2017
How many times did you scroll through the list of installed plug-ins wondering why
this or that plug-in was installed once upon a time? « Plugin Notes » helps you
to answer this questions quickly by adding a note. Very simple, very useful!
[ Read all 26 reviews ](https://wordpress.org/support/plugin/plugin-notes/reviews/)
## Contributors & Developers
“Plugin Notes” is open source software. The following people have contributed to
this plugin.
Contributors
* [ Mohammad Jangda ](https://profiles.wordpress.org/batmoo/)
* [ Chris Dillon ](https://profiles.wordpress.org/cdillon27/)
* [ Juliette Reinders Folmer ](https://profiles.wordpress.org/jrf/)
[Translate “Plugin Notes” into your language.](https://translate.wordpress.org/projects/wp-plugins/plugin-notes)
### Interested in development?
[Browse the code](https://plugins.trac.wordpress.org/browser/plugin-notes/), check
out the [SVN repository](https://plugins.svn.wordpress.org/plugin-notes/), or subscribe
to the [development log](https://plugins.trac.wordpress.org/log/plugin-notes/) by
[RSS](https://plugins.trac.wordpress.org/log/plugin-notes/?limit=100&mode=stop_on_copy&format=rss).
## Changelog
#### 2015-06-13 / 1.6 Originally released Dec 2012 by jrf
* [_New feature_] Added ability to change the background color of notes.
#### 2015-06-09 / 1.5 Originally released Dec 2012 by jrf
* [_Bug fix_] Fixed AJAX delete bug (kept ‘waiting’).
* [_New feature_] Added output filters for html output (`plugin_notes_row` and `
plugin_notes_form`) and the note itself (`plugin_notes_note`).
* [_New feature_] Added ability to use a number of variables in notes which will
automagically be replaced – see [FAQ](https://wordpress.org/plugins/plugin-notes/faq/)
for more info.
* [_New feature_] Added ability to use markdown syntax in notes – see [FAQ](https://wordpress.org/plugins/plugin-notes/faq/)
for more info.
* [_Usability improvement_] Added `
` to allowed tags list and made the tag
list filterable through the new `plugin_notes_allowed_tags` filter.
* [_Usability improvement_] Made the default text area for adding a note larger.
* [_Usability improvement_] Added automagical target= »_blank » to all links in
plugin notes including external link indicator.
* [_Usability improvement_] Added contextual help for WP 3.3+,
* [_Usability improvement_] Added FAQ section and plugin license info to the readme
file 😉
* [_Usability improvement_] Added uninstall script for clean uninstall of the plugin.
* [_Usability improvement_] Added minified versions of the js and css files.
* [_I8n_] Created .POT file and added Dutch translation.
* [_Security_] Improved output escaping.
#### 2015-04-15 / 1.2
* Fix strict warning: Redefining already defined constructor.
* Version bump for WordPress 4.1.
#### 2010-10-15 / 1.1
* Certain HTML tags are now allowed in notes: ` ![]()
`. Thanks to [Dave Abrahams](http://www.boostpro.com) for suggesting this
feature.
* Some style tweaks
* Fixed PHP Error Notices
#### 2009-12-04 / 1.0
* Fixed a major bug that was causing fatal errors
* Added some inline code comments
* Changed around some minor styling.
* Bumping release number up to 1.0 because I feel like it
#### 2009-10-24 / 0.1
* Initial beta release
## Meta
* Version **1.6**
* Last updated **11 années ago**
* Active installations **500+**
* WordPress version ** 3.5 or higher **
* Tested up to **4.2.39**
* Language
* [English (US)](https://wordpress.org/plugins/plugin-notes/)
* Tags
* [memo](https://tah.wordpress.org/plugins/tags/memo/)[meta](https://tah.wordpress.org/plugins/tags/meta/)
[plugin notes](https://tah.wordpress.org/plugins/tags/plugin-notes/)[plugins](https://tah.wordpress.org/plugins/tags/plugins/)
* [Advanced View](https://tah.wordpress.org/plugins/plugin-notes/advanced/)
## Ratings
5 out of 5 stars.
* [ 26 5-star reviews ](https://wordpress.org/support/plugin/plugin-notes/reviews/?filter=5)
* [ 0 4-star reviews ](https://wordpress.org/support/plugin/plugin-notes/reviews/?filter=4)
* [ 0 3-star reviews ](https://wordpress.org/support/plugin/plugin-notes/reviews/?filter=3)
* [ 0 2-star reviews ](https://wordpress.org/support/plugin/plugin-notes/reviews/?filter=2)
* [ 0 1-star reviews ](https://wordpress.org/support/plugin/plugin-notes/reviews/?filter=1)
[Add my review](https://wordpress.org/support/plugin/plugin-notes/reviews/#new-post)
[See all reviews](https://wordpress.org/support/plugin/plugin-notes/reviews/)
## Contributors
* [ Mohammad Jangda ](https://profiles.wordpress.org/batmoo/)
* [ Chris Dillon ](https://profiles.wordpress.org/cdillon27/)
* [ Juliette Reinders Folmer ](https://profiles.wordpress.org/jrf/)
## Support
Got something to say? Need help?
[View support forum](https://wordpress.org/support/plugin/plugin-notes/)
## Donate
Would you like to support the advancement of this plugin?
[ Donate to this plugin ](http://digitalize.ca/donate)