Описание
Вам случалось возвращаться на созданный вами ранее сайт и задаваться вопросом: «Для чего я поставил тот или иной плагин?» Этот плагин добавит дополнительный столбец на странице «Плагины», что позволит вам добавлять, редактировать или удалять примечания о плагинах, которые вы установили на конкретном сайте. Эти примечания предназначены для обеспечения возможности документирования, почему был установлен конкретный плагин и как и где он используется.
Возможности
- Добавление стольких примечаний, сколько требуется для каждого плагина.
- Редактирование или удаление примечаний при желании.
- Возможность выбора иконки к каждому примечанию, для быстрого отображения типа содержащейся информации (например, информационной, предупреждающей, ссылки и т.д.).
- Форматирование примечаний с использованием основных тегов HTML, при желании.
- Любые ссылки, включенные в примечания, будут автоматически преобразованы в
target="_blank"
- Примечания добавляются и обновляются через Ajax, что позволяет избежать медленных перезагрузок страницы.
- Примечания также отображаются на странице обновлений WordPress для всех плагинов в списке обновлений.
- Имеется фильтр, позволяющий, если вы хотите, отобразить примечание под описанием плагина, а не в отдельном столбце.
- Доступен фильтр для выборочного скрытия или отображения заметок к плагинам в админке.
Скриншоты
Установка
- Вы можете установить плагин через раздел «Плагины» вашего WordPress, или загрузить файлы вручную на свой сервер, распаковав файл .zip и поместив его содержимое в каталог /wp-content/plugins/.
- Активируйте плагин на странице «Плагины» в панели управления WordPress.
- Добавляете, редактируйте или удаляйте примечания к плагинам в разделе «Плагины > Установленные» столбец «Примечание».
Часто задаваемые вопросы
-
Могу ли я отобразить примечание к плагинам под описанием плагина, а не в отдельном столбце?
-
С версии 1.2.4 вы можете использовать фильтр plugin-notes-plus_note_placement, чтобы переместить примечания под описание плагина.
Вот пример фрагмента кода, который помещает примечание к плагину под его описание. Он может быть добавлен в functions.php вашей дочерней темы. Без этого добавления, позиция примечания будет по умолчанию – в виде отдельного столбца на странице плагинов.
function pnp_change_note_placement( $note_placement ) { $note_placement = 'description'; return $note_placement; } add_filter( 'plugin-notes-plus_note_placement', 'pnp_change_note_placement' );
-
Могу ли я изменить список иконок отображающихся рядом с примечаниями плагинов?
-
Да, вы можете использовать фильтр 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-теги:
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-установки поддерживает свои собственные примечания к плагинам. Кроме того, супер-админ может иметь свои собственные примечания к плагинам.
-
Могу ли я скрыть заметку о плагине от определенных пользователей?
-
Начиная с версии 1.2.6, вы можете использовать фильтр plugin-notes-plus_hide_notes, чтобы отобразить или скрыть заметку к плагину.
Вот пример фрагмента кода, который скрывает заметки о плагине от конкретного пользователя. Его можно добавить в functions.php вашей дочерней темы. Без него, заметки о плагинах отображаются по умолчанию для всех пользователей, которые могут просматривать страницу плагинов.
function pnp_hide_notes( $hide_notes ) { // logic to set $hide_notes to TRUE or FALSE return $hide_notes; } add_filter( 'plugin-notes-plus_hide_notes', 'pnp_hide_notes' );
Отзывы
Участники и разработчики
«Plugin Notes Plus» — проект с открытым исходным кодом. В развитие плагина внесли свой вклад следующие участники:
Участники«Plugin Notes Plus» переведён на 8 языков. Благодарим переводчиков за их работу.
Перевести «Plugin Notes Plus» на ваш язык.
Заинтересованы в разработке?
Посмотрите код, проверьте SVN репозиторий, или подпишитесь на журнал разработки по RSS.
Журнал изменений
1.2.8
- Fixed: Checking for user permission on ajax requests.
1.2.7
- Fixed: Cross site scripting (XSS) vulnerability related to icon rendering.
1.2.6
- Добавлено: возможность выборочного отображения или скрытия заметок к плагинам. Спасибо @garconis за предложение.
1.2.5
- Исправлено: предупреждение PHP (PHP warning), вызванное устаревшим использованием wp_localize_script. Спасибо @brianhenryie за выявление этого.
1.2.4
- Добавлено: опция для отображения примечаний под описанием плагина. Спасибо @antipole за предложение.
1.2.3
- Добавлено: Иконка «деньги» в списке вариантов. Спасибо @brianhenryie.
1.2.2
- Добавлено: Обновления для совместимости с RTL. Спасибо @ramiy.
- Удалено: ненужные po и mo файлы переводов.
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
- Релиз первой версии плагина.