Plugin Notes Plus

Описание

Вы когда-нибудь возвращались на сайт, который вы создали некоторое время назад, и спрашивали: «Чувак, почему я установил этот плагин?» Этот плагин создаёт дополнительный столбец в разделе «Плагины», который позволяет добавлять, редактировать или удалять примечания о плагинах, которые вы установили на конкретных сайтах. Эти примечания предназначены для информирования о том, почему каждый плагин был установлен и как и где он используется.

Возможности

  • Добавление стольких примечаний, сколько требуется для каждого плагина.
  • Редактирование или удаление примечаний при желании.
  • Возможность выбора иконки к каждому примечанию, для быстрого отображения типа содержащейся информации (например, информационной, предупреждающей, ссылки и т.д.).
  • Форматирование примечаний с использованием основных тегов HTML, при желании.
  • Любые ссылки, включенные в примечания, будут автоматически преобразованы в target="_blank"
  • Примечания добавляются и обновляются через Ajax, что позволяет избежать медленных перезагрузок страницы.
  • Примечания также отображаются на странице обновлений WordPress для всех плагинов в списке обновлений.

Скриншоты

  • После активации плагина вы увидите новый столбец на странице плагинов, который позволяет добавлять, редактировать или удалять примечания о плагинах, которые вы установили на каждом конкретном сайте.

Установка

  1. Вы можете установить плагин через раздел «Плагины» вашего WordPress, или загрузить файлы вручную на свой сервер, распаковав файл .zip и поместив его содержимое в каталог /wp-content/plugins/.
  2. Активируйте плагин на странице «Плагины» в панели управления WordPress.
  3. Добавляете, редактируйте или удаляйте примечания к плагинам в разделе «Плагины > Установленные» столбец «Примечание».

Часто задаваемые вопросы

Могу ли я изменить список иконок отображающихся рядом с примечаниями плагинов?

Да, вы можете использовать фильтр plugin-notes-plus_icon_options, чтобы изменить набор доступных значков. Иконки должны быть выбраны из списка доступных иконок панели управления WordPress.

Вот пример фрагмента, который удаляет одну иконку и добавляет другую, дополнительную иконку, в список. Добавляется в 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' );
Какие HTML-теги разрешены, и можно ли изменить этот список?

Вы можете использовать следующие HTML-теги: a, br, p, b, strong, i, em, u, hr.

Чтобы изменить список доступных тегов, используйте фильтр plugin-notes-plus_allowed_html. Однако будьте осторожны, чтобы не допустить появления тегов, которые могут сделать сайт уязвимым для XSS-атаки.

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' );
Где сохранены данные?

Примечания к плагинам и метаданные хранятся в отдельной таблице название которой заканчивается на plugin_notes_plus. В первоначальной версии (1.0.0), примечания сохранялись в таблице options. Версия 1.1.0 была выпущена для переноса существующих примечаний из таблицы options в таблицу plugin_notes_plus. Обновление до версии 1.1.1 выполнит очистку, удалив все примечания из таблицы options.

Как это работает в установленном режиме Multisite?

Каждый сайт multisite-установки поддерживает свои собственные примечания к плагинам. Кроме того, супер-админ может иметь свои собственные примечания к плагинам.

Отзывы

28.08.2019
The WordPress team should incorporate this plug-in as part of the core product! That's how useful it is. The WordPress design philosophy is lots of plugins being installed -- potentially fine-grained ones -- to add to the WordPress functionality to avoid doing PHP programming. However, the negative side of that is the maintenance nightmare of tracking in your head "Why did I install that obscure plug-in? What is it used for on my site?"; in the worst case, you weaken the security of your site as you are too scared to disable any (potentially) unused or unimportant plug-in as you don't know if it is providing a crucial role or not! This plug-in solves all that!
16.08.2019
I install this on all sites I manage. It's particularly great when not the sole admin on a site.
17.07.2019
Dang man, you stole my idea for a simple plugin to make! 🙂 Well done...
25.06.2019
This plugin is an amazing help on our site where we have multiple admins. Any one of us could add a plugin and it's so simple to add a note telling what it's for. We have notes for a few trouble plugins saying not to update past a certain version until it gets fixed. That's been a lifesaver. We also have some really useful notes about what pages a particular shortcode plugin was installed to be used on, etc.
28.05.2019
Wow, I've only just started to use this plugin on our new Gutenberg built site. It is fantastic! Bud Kraus of JoyofWP.com recommended it. What a lifesaver for anyone who's ever wondered, "What is that doing there and who installed it?" I've now added notes to all my new plugins, along with why I added them, who recommended them or where I learned about them as well as if I plan to keep them or replace them with others after a trial period. Thank you for creating this for us! Linda
22.05.2019
There is so much "extra information" in my head about plugins on our complex site, that I know I can never remember it all. I have documentation in Redmine, but that not "right there" when and where I need it. This plugin saves the day!!! I have one little wishlist item: Make it multisite compatible. It "works" on multisite, but it works independently on each site. I would give it 10 stars if the notes I make on plugins at the network level would act as "master" notes, and be visible on the subsites in the network. Awesome job, hope to see it grow!
Посмотреть все 23 отзыва

Участники и разработчики

«Plugin Notes Plus» — проект с открытым исходным кодом. В развитие плагина внесли свой вклад следующие участники:

Участники

«Plugin Notes Plus» переведён на 3 языка. Благодарим переводчиков за их работу.

Перевести «Plugin Notes Plus» на ваш язык.

Заинтересованы в разработке?

Посмотрите код, проверьте SVN репозиторий, или подпишитесь на журнал разработки по RSS.

Журнал изменений

1.2.1

  • Исправлено: ошибка JavaScript, которая иногда возникала в update-core.php, если в плагине не было примечаний. Спасибо @brianhenryie за то, что обратили на это моё внимание.
  • Добавлено: венгерский перевод. Спасибо @tomek00.

1.2.0

  • Добавлено: примечания к плагинам теперь отображаются в формате только для чтения на странице обновлений WordPress (update-core.php). Спасибо @douglsmith за предложение.
  • Исправлено: убран ненужный мультисайтовый хук. Спасибо @foomagoo за указание на это.

1.1.2

  • Исправлено: ошибка, которая мешала пользователю добавлять или обновлять заметки после ответа Ajax. Спасибо @anticosti за помощь в выявлении этой ошибки.
  • Добавлено: вращающаяся иконка, указывающая, что примечание в процессе удаления.

1.1.1

  • Добавлено: Процедура очистки для удаления примечаний из таблицы options. (При обновлении с 1.0.0 примечания сначала будут перенесены в собственную таблицу.)

1.1.0

  • Исправлено: ошибка, приводившая к исчезновению примечаний на серверах Windows из-за расхождений в пути к файлу плагина, связанных с прямой и обратной косой чертой. Это обновление восстановит отсутствующие примечания. Спасибо @gwalsh66 за помощь в выявлении этой ошибки.
  • Изменено: примечания к плагинам теперь будут храниться в отдельной таблице $wpdb->prefix . 'plugin_notes_plus'
  • Добавлено: процедура переноса примечаний из таблицы options в собственную таблицу при обновлении с версии 1.0.0
  • Добавлено: запись в таблице options под названием «plugin_notes_plus_db_version» для определения таблицы базы данных.

1.0.0

  • Релиз первой версии плагина.