Описание default_contextual_help
— Filter
Хук default_contextual_help позволяет изменять контекстную помощь на страницах админ-панели WordPress. Он срабатывает на экранах редактирования постов, страниц и других типах записей, позволяя разработчикам добавлять или изменять текст помощи для пользователей
Примеры использования
Пример добавления дополнительной информации в контекстную помощь на странице редактирования поста:
add_filter('default_contextual_help', function($help, $screen) {
if ('post' === $screen->id) {
$help .= 'Дополнительная информация о редактировании постов.
';
}
return $help;
});
В этом примере мы добавляем новую строку помощи только на странице редактирования поста
Пример изменения текста помощи на странице редактирования страницы:
add_filter('default_contextual_help', function($help, $screen) {
if ('page' === $screen->id) {
$help = 'Это страница редактирования.
';
}
return $help;
});
Здесь мы заменяем всю помощь на странице редактирования страницы на новый текст
Пример добавления HTML-контента в помощь на странице редактирования пользовательского типа записи:
add_filter('default_contextual_help', function($help, $screen) {
if ('my_custom_post_type' === $screen->id) {
$help .= 'Помощь для вашего пользовательского типа записи
';
}
return $help;
});
В этом примере мы добавляем заголовок в контекстную помощь для пользовательского типа записи
— Лучшие практики
– Использование
Используйте этот хук, когда необходимо предоставить дополнительную информацию или помощь для пользователей на страницах админ-панели
– Производительность
Хук не должен значительно влиять на производительность, так как изменения касаются только вывода HTML
– Предупреждения
Убедитесь, что добавляемая информация актуальна и полезна для пользователей
Альтернативы
Тип: action
Этот хук позволяет добавлять помощь и информацию на экранах редактирования и других страницах админ-панели
Используйте его, если нужно добавить дополнительный функционал или информацию в контекстную помощь