Описание documentation_ignore_functions
— Filter
Хук documentation_ignore_functions позволяет изменять список функций, которые будут игнорироваться в документации WordPress. Он срабатывает при формировании документации и помогает исключать определённые функции из вывода
Примеры использования
Пример добавления функции в список игнорируемых:
add_filter('documentation_ignore_functions', function($ignored) {
$ignored[] = 'my_custom_function';
return $ignored;
});
В этом примере мы добавляем ‘my_custom_function’ в список функций, которые будут игнорироваться в документации
Пример удаления существующей функции из списка игнорируемых:
add_filter('documentation_ignore_functions', function($ignored) {
$ignored = array_diff($ignored, ['another_function']);
return $ignored;
});
Здесь мы удаляем ‘another_function’ из списка игнорируемых функций
Пример игнорирования нескольких функций:
add_filter('documentation_ignore_functions', function($ignored) {
$ignored = array_merge($ignored, ['func_one', 'func_two']);
return $ignored;
});
В этом примере мы добавляем несколько функций в список игнорируемых
— Лучшие практики
– Использование
Используйте этот хук, когда необходимо исключить определённые функции из документации для улучшения читаемости и удобства
– Производительность
Хук не должен существенно влиять на производительность, так как изменения касаются только вывода документации
– Предупреждения
Убедитесь, что исключаемые функции не являются критически важными для понимания работы системы
Альтернативы
Тип: filter
Этот хук позволяет управлять функциями, которые должны быть включены в документацию, что является противоположным подходом
Используйте его, если нужно явно указать функции, которые должны быть включены в документацию
