Описание contextual_help
— Action
Хук contextual_help позволяет добавлять контекстную помощь на страницы редактирования в админ-панели WordPress. Он срабатывает при отображении области помощи и позволяет расширить информацию, доступную пользователям, улучшая их понимание функционала страницы
Примеры использования
Пример добавления контекстной помощи на страницу редактирования поста:
add_action('contextual_help', function($help, $screen_id) {
if ('post' === $screen_id) {
$help .= '<p>Это дополнительная информация о редактировании поста.</p>';
}
return $help;
}, 10, 2);
В данном примере добавляется дополнительная информация на страницу редактирования поста
Пример добавления контекстной помощи на страницу настройки плагина:
add_action('contextual_help', function($help, $screen_id) {
if ('settings_page_my_plugin' === $screen_id) {
$help .= '<p>Здесь вы можете настроить параметры вашего плагина.</p>';
}
return $help;
}, 10, 2);
Здесь добавляется информация на страницу настроек плагина
— Лучшие практики
– Использование
Используйте этот хук, когда необходимо предоставить дополнительную информацию пользователям на страницах редактирования
– Производительность
Хук не должен негативно сказываться на производительности, так как он добавляет лишь HTML-контент
– Предупреждения
Убедитесь, что добавляемая информация актуальна и полезна для пользователя
Альтернативы
Тип: action
Этот хук позволяет выводить уведомления в админ-панели, но не обязательно в контексте конкретного экрана
Используйте его, если нужно показать уведомления или предупреждения, которые не зависят от контекста конкретной страницы
