Описание contextual_help_list
— Filter
Хук contextual_help_list позволяет изменить список контекстной помощи в админ-панели WordPress. Он срабатывает при отображении экрана помощи и позволяет разработчикам добавлять или модифицировать информацию, доступную пользователям в интерфейсе администрирования
Примеры использования
Пример добавления кастомной контекстной помощи:
add_filter('contextual_help_list', function($help) {
$help[] = array('text' => 'Это полезная информация для администраторов', 'link' => 'https://example.com/help');
return $help;
});
В этом примере мы добавляем новую запись в контекстную помощь с текстом и ссылкой
Пример замены существующей контекстной помощи:
add_filter('contextual_help_list', function($help) {
if (isset($help[0])) {
$help[0]['text'] = 'Обновленная информация о разделе';
}
return $help;
});
Здесь мы обновляем текст первой записи в контекстной помощи
Пример удаления контекстной помощи:
add_filter('contextual_help_list', function($help) {
if (count($help) > 0) {
unset($help[0]);
}
return $help;
});
В этом примере мы удаляем первую запись из контекстной помощи
— Лучшие практики
– Использование
Используйте этот хук, когда необходимо добавить или изменить информацию, доступную пользователям в контекстной помощи админ-панели
– Производительность
Хук не должен значительно влиять на производительность, так как изменения касаются только отображаемой информации
– Предупреждения
Следите за тем, чтобы изменения были актуальными и не вводили пользователей в заблуждение
Альтернативы
Тип: action
Этот хук позволяет добавить дополнительный функционал к существующей помощи в админ-панели
Используйте его, если нужно добавить дополнительные элементы или функционал к уже существующей помощи