wp_register_icon_collection()
Регистрирует новую коллекцию SVG-иконок.
Коллекция объединяет связанные иконки и служит пространством имён. Например, для иконки my-plugin/star коллекцией будет my-plugin.
Коллекцию нужно зарегистрировать до вызова wp_register_icon(). Рекомендуется делать это на событии init.
Работает на основе: WP_Icon_Collections_Registry::register()
Хуков нет.
Возвращает
true|false.
true- коллекция успешно зарегистрирована.false- переданы некорректные параметры или коллекция с таким слагом уже существует. WordPress также создаст уведомление_doing_it_wrong().
Использование
wp_register_icon_collection( $slug, $args );
- $slug(string) (обязательный)
Уникальный слаг коллекции.
Должен начинаться и заканчиваться строчной латинской буквой или цифрой. Внутри можно использовать строчные латинские буквы, цифры, дефисы и подчёркивания.
Например:
my-plugin,theme_icons,icons2.- $args(array) (обязательный)
Параметры коллекции. Неизвестные ключи приведут к ошибке регистрации.
-
label(string) (обязательный)
Понятное пользователю название коллекции. Отображается в интерфейсе выбора иконок. - description(string)
Описание коллекции.
По умолчанию: ''
-
Примеры
#1 Регистрация коллекции иконок плагина
add_action( 'init', 'my_plugin_register_icon_collection' );
function my_plugin_register_icon_collection() {
wp_register_icon_collection(
'my-plugin',
[
'label' => __( 'My Plugin Icons', 'my-plugin' ),
'description' => __( 'Icons provided by My Plugin.', 'my-plugin' ),
]
);
}Список изменений
| С версии 7.1.0 | Введена. |
Код wp_register_icon_collection() wp register icon collection WP 7.1
function wp_register_icon_collection( $slug, $args ) {
return WP_Icon_Collections_Registry::get_instance()->register( $slug, $args );
}