Как использовать фильтр plugin_row_meta для добавления полезных ссылок на страницу плагинов в WordPress

Фильтр plugin_row_meta позволяет разработчикам плагинов добавлять кастомные ссылки рядом с каждым плагином на странице «Плагины» в административной панели WordPress. Это отличный способ улучшить пользовательский интерфейс, добавив ссылки на документацию, страницу поддержки или даже премиум-версии плагина.

Что такое plugin_row_meta?

plugin_row_meta — это фильтр, который применяется к мета-данным, отображаемым под названием плагина на странице Плагины в административной панели WordPress. По умолчанию WordPress отображает несколько ссылок, таких как «Просмотр деталей» или «Удалить», но вы можете добавить свои собственные ссылки, используя этот фильтр.

Когда использовать plugin_row_meta?

Используйте plugin_row_meta, если вы хотите:

  • Добавить ссылку на документацию для вашего плагина.
  • Предложить пользователю перейти на премиум-версию плагина.
  • Добавить ссылку на страницу поддержки или форум.
  • Информировать пользователя о других ваших продуктах.

Пример использования plugin_row_meta

Вот пример того, как добавить несколько кастомных ссылок на страницу плагинов:

add_filter( 'plugin_row_meta', 'custom_plugin_row_meta', 10, 2 );

/**
 * Добавление кастомных ссылок под плагином.
 *
 * @param array  $plugin_meta Список существующих ссылок.
 * @param string $plugin_file Путь к файлу плагина.
 *
 * @return array Модифицированный список ссылок.
 */
function custom_plugin_row_meta( $plugin_meta, $plugin_file ) {

    // Убедимся, что ссылки добавляются только для нужного плагина
    if ( plugin_basename( __FILE__ ) == $plugin_file ) {
        $plugin_meta[] = '<a href="https://example.com/docs" target="_blank">Документация</a>';
        $plugin_meta[] = '<a href="https://example.com/support" target="_blank">Поддержка</a>';
        $plugin_meta[] = '<a href="https://example.com/premium" target="_blank">Премиум-версия</a>';
    }

    return $plugin_meta;
}

Пояснение к коду:

  1. Фильтр plugin_row_meta — используется для изменения списка ссылок внизу каждого плагина.
  2. Функция custom_plugin_row_meta — добавляет кастомные ссылки к определённому плагину.
  3. Проверка plugin_basename() — позволяет убедиться, что ссылки добавляются только для конкретного плагина, который вы разрабатываете.
  4. Ссылки — вы можете добавить любое количество ссылок. В примере мы добавляем три ссылки: на документацию, поддержку и премиум-версию.

Преимущества добавления кастомных ссылок

Добавление пользовательских ссылок через фильтр plugin_row_meta улучшает взаимодействие с пользователями, поскольку они могут быстро найти нужные ресурсы, такие как документация или служба поддержки, без необходимости покидать административную панель WordPress. Это может повысить их удовлетворенность вашим продуктом и облегчить поддержку.

Почитаем еще?: