is_plugin_active()

Определяет, активен ли плагин
Функция WordPress
INT 2.5.0
WordPress Icon

Описание функции

Функция is_plugin_active() используется для определения активности плагина в WordPress.

Она принимает путь к файлу плагина относительно директории плагинов и возвращает булево значение — true, если плагин активен, и false, если плагин не активен.

Использование

is_plugin_active( string $plugin ): bool

Функция is_plugin_active() принимает один обязательный параметр:

  • $plugin (string) — Путь к файлу плагина относительно директории плагинов.

Функция is_plugin_active() возвращает булево значение:

  • true — если плагин активен и находится в списке активных плагинов.
  • false — если плагин не активен и не находится в списке активных плагинов.

/**
 * Проверяет, активен ли плагин "example-plugin".
 * 
 * @param string $plugin Путь к файлу плагина относительно директории плагинов.
 * @return bool Возвращает true, если плагин активен, и false, если плагин не активен.
 */
$is_active = is_plugin_active( 'example-plugin/example-plugin.php' );
if ( $is_active ) {
  // Действия, если плагин активен.
  // ...
} else {
  // Действия, если плагин не активен.
  // ...
}

В приведенном выше примере мы используем функцию is_plugin_active() для проверки активности плагина «example-plugin».

Если плагин активен, выполняются действия в блоке if. Если плагин не активен, выполняются действия в блоке else.

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

Определение активности плагина


/**
 * Определяет, активен ли плагин.
 *
 * @param string $plugin Путь к файлу плагина относительно директории плагинов.
 * @return bool Возвращает true, если плагин активен, и false, если плагин не активен.
 */
function is_plugin_active( $plugin ) {
    // Реализация функции
}

Функция is_plugin_active() определяет, активен ли плагин. Она принимает один обязательный параметр — путь к файлу плагина относительно директории плагинов. Функция не возвращает никакого значения, она лишь определяет статус активности плагина.

Проверка активности плагина


$plugin = 'my-plugin/my-plugin.php';
if ( is_plugin_active( $plugin ) ) {
    // Плагин активен
    echo 'Плагин активен.';
} else {
    // Плагин не активен
    echo 'Плагин не активен.';
}

В данном примере мы проверяем активность плагина с путем my-plugin/my-plugin.php. Если плагин активен, выводится сообщение «Плагин активен.», иначе выводится сообщение «Плагин не активен.»

Получение статуса активности плагина


$plugin = 'my-plugin/my-plugin.php';
$plugin_status = is_plugin_active( $plugin );
if ( $plugin_status ) {
    // Плагин активен
    echo 'Плагин активен.';
} else {
    // Плагин не активен
    echo 'Плагин не активен.';
}

В данном примере мы используем функцию is_plugin_active() для определения статуса активности плагина с путем my-plugin/my-plugin.php. Результат функции сохраняется в переменной $plugin_status. Затем мы проверяем значение переменной и выводим соответствующее сообщение.

Проверка наличия плагина в списке активных


$plugin = 'my-plugin/my-plugin.php';
$active_plugins = get_option( 'active_plugins' );
if ( in_array( $plugin, $active_plugins ) ) {
    // Плагин присутствует в списке активных
    echo 'Плагин присутствует в списке активных.';
} else {
    // Плагин отсутствует в списке активных
    echo 'Плагин отсутствует в списке активных.';
}

В данном примере мы используем функцию is_plugin_active() для проверки наличия плагина с путем my-plugin/my-plugin.php в списке активных плагинов. Для этого мы получаем список активных плагинов с помощью функции get_option() и проверяем, содержит ли этот список указанный плагин с помощью функции in_array(). В зависимости от результата выводится соответствующее сообщение.

Вопросы и ответы

Что возвращает функция is_plugin_active()?

Функция is_plugin_active() возвращает логическое значение true, если указанный плагин активен, и false, если плагин не активен.

Как использовать функцию is_plugin_active() в условных выражениях?

Функция is_plugin_active() может быть использована в условных выражениях для проверки активности плагина. Например:


if ( is_plugin_active( 'plugin-folder/plugin-file.php' ) ) {
    // Выполнить действия, если плагин активен
} else {
    // Выполнить действия, если плагин не активен
}

Какие ошибки могут возникнуть при использовании функции is_plugin_active()?

При использовании функции is_plugin_active() могут возникнуть следующие ошибки:

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

Функция is_plugin_active() позволяет определить, активен ли указанный плагин в WordPress. Она возвращает логическое значение, которое можно использовать в условных выражениях для выполнения различных действий в зависимости от активности плагина. Необходимо быть внимательным при использовании этой функции, чтобы избежать ошибок и неправильных результатов.

Связанные элементы

  • Функция activate_plugin(): активирует указанный плагин.
  • Функция deactivate_plugins(): деактивирует указанные плагины.
  • Функция is_plugin_inactive(): определяет, неактивен ли плагин.
  • Функция get_plugins(): возвращает массив данных о всех доступных плагинах.
  • Функция register_activation_hook(): регистрирует функцию, которая будет выполнена при активации плагина.
  • Функция register_deactivation_hook(): регистрирует функцию, которая будет выполнена при деактивации плагина.
  • Хук activated_plugin: вызывается после активации плагина.
  • Хук deactivated_plugin: вызывается после деактивации плагина.
  • Класс WP_Plugins_List_Table: отображает таблицу со списком плагинов в административной части.
Обсуждение