Плагин для WordPress

Требования: WordPress 5.6 или новее, PHP 7.2 или новее и платный тариф Правки.Про (какие бывают). Скачать плагин: pravki-pro.zip.

Установка

Доступ в кабинет Правки.Про разработчику клиента не нужен — достаточно ключа виджета и ссылки на эту страницу.

1. Скачайте плагинФайл pravki-pro.zip — около 140 КБ. Распаковывать не нужно, WordPress принимает архив как есть.
2. Установите в WordPressПлагины → Добавить новый → Загрузить плагин → выберите ZIP → Установить → Активировать.
3. Возьмите ключ виджетаВ кабинете Правки.Про: проект → «Виджет на сайте» → «Код для установки». Ключ — значение data-key.
4. Вставьте ключ в настройкиНастройки → Правки.Про. Можно вставить всю скопированную строку <script …> целиком — ключ вынется сам.

Сразу после сохранения плагин сам проверит ключ и напишет, принимает ли виджет правки — а если нет, то почему. Кнопка «Правка» появится на всех страницах сайта.

Показывать только администраторам

Приёмка часто идёт на уже открытом сайте. Галочка в настройках плагина оставляет кнопку «Правка» только вошедшим в WordPress пользователям с правом управления сайтом.

• Посетители не видят ничего. Скрипт виджета вообще не попадает в страницу для обычного посетителя — ни кнопки, ни запросов к Правки.Про, ни лишних килобайт.
• Кеш не подведёт. Страницу с виджетом плагин помечает как некешируемую, чтобы кеш-плагин не отдал «админскую» версию всем подряд.

Что попадает в правку

• Скриншот с выделенным местом — снимок видимой области с рамкой вокруг элемента, по которому кликнул клиент. Разбирать CSS-селектор человеку не нужно.
• Запись действий — по желанию. Клиент нажимает «Записать действия» и показывает баг курсором. Поля ввода в записи маскируются, запись не идёт фоном.
• Контекст страницы — адрес, размер окна, браузер и плотность пикселей, чтобы не переспрашивать «а у вас на чём?».
• Из личного — только имя. Клиент вводит его сам, оно остаётся в localStorage его браузера. Плагин не собирает данные посетителей сайта.

Кнопка «Правка» не появилась

Сначала откройте Настройки → Правки.Про: плагин показывает состояние виджета прямо там. Ниже — все причины, по которым виджет молчит.

Разработчику

Сайт не на WordPress — плагин не нужен, виджет ставится одной строкой перед закрывающим </body>:

<script src="https://pravki.pro/widget.js" data-key="ВАШ_КЛЮЧ" defer></script>

Показывать не только администраторам, а, скажем, редакторам — фильтром в теме или mu-плагине:

add_filter('pravki_pro_user_allowed', fn() => current_user_can('edit_pages'));

Отключить виджет на отдельных страницах:

add_filter('pravki_pro_should_render', fn($yes) => is_page('checkout') ? false : $yes);

Своя установка Правки.Про — Настройки → Правки.Про → «Дополнительно» → «Адрес сервиса». Либо в wp-config.php:

define('PRAVKI_PRO_DEFAULT_HOST', 'https://my.pravki.host');

Ключ виджета не секрет: он и так виден в исходном коде страницы и позволяет только создавать правки в целевом пуле — прочитать им нельзя ничего. Чтобы виджет не работал на посторонних сайтах, задайте в кабинете список разрешённых доменов.