WordPress как на ладони
wordpress jino

register_taxonomy() WP 2.3

Добавляет (регистрирует) новую (пользовательскую) таксономию. Можно перезаписать существующую таксономию.

Функцию желательно вызывать во время события init (хук):

add_action('init', 'function_name');

В качестве названия для новой таксономии нужно указывать уникальное имя, отличное от уже имеющихся таксономий, типов постов и зарезервированных WordPress публичных и частных переменных.

Полный список названий (черный список), которые не могут быть использованы, в качестве имени новой таксономии.

Когда нужно зарегистрировать новый тип записи, используйте register_post_type()

Работает на основе: WP_Taxonomy()
Хуки из функции:
Возвращает

Ничего или WP_Error.

Использование

register_taxonomy( $taxonomy, $object_type, $args );

Шаблон использования

// хук для регистрации
add_action('init', 'create_taxonomy');
function create_taxonomy(){
	// список параметров: http://wp-kama.ru/function/get_taxonomy_labels
	register_taxonomy('taxonomy', array('post'), array(
		'label'                 => '', // определяется параметром $labels->name
		'labels'                => array(
			'name'              => 'Genres',
			'singular_name'     => 'Genre',
			'search_items'      => 'Search Genres',
			'all_items'         => 'All Genres',
			'view_item '        => 'View Genre',
			'parent_item'       => 'Parent Genre',
			'parent_item_colon' => 'Parent Genre:',
			'edit_item'         => 'Edit Genre',
			'update_item'       => 'Update Genre',
			'add_new_item'      => 'Add New Genre',
			'new_item_name'     => 'New Genre Name',
			'menu_name'         => 'Genre',
		),
		'description'           => '', // описание таксономии
		'public'                => true,
		'publicly_queryable'    => null, // равен аргументу public
		'show_in_nav_menus'     => true, // равен аргументу public
		'show_ui'               => true, // равен аргументу public
		'show_tagcloud'         => true, // равен аргументу show_ui
		'show_in_rest'          => null, // добавить в REST API
		'rest_base'             => null, // $taxonomy
		'hierarchical'          => false,
		'update_count_callback' => '',
		'rewrite'               => true,
		//'query_var'             => $taxonomy, // название параметра запроса
		'capabilities'          => array(),
		'meta_box_cb'           => null, // callback функция. Отвечает за html код метабокса (с версии 3.8): post_categories_meta_box или post_tags_meta_box. Если указать false, то метабокс будет отключен вообще
		'show_admin_column'     => false, // Позволить или нет авто-создание колонки таксономии в таблице ассоциированного типа записи. (с версии 3.5)
		'_builtin'              => false,
		'show_in_quick_edit'    => null, // по умолчанию значение show_ui
	) );
}
$taxonomy(строка) (обязательный)
Название создаваемой таксономии.
Может содержать только строчные латинские символы, числа и _, т.е. a-z0-9_.
По умолчанию: ''
$object_type(строка/массив) (обязательный)
Название типов постов, к которым будет привязана таксономия. В этом параметре, например, можно указать 'post', тогда у обычных постов WordPress появится новая таксономия (возможность классификации).
По умолчанию: ''
$args(массив) (обязательный)
Массив аргументов определяющий признаки таксономии.
По умолчанию: нет

Аргументы параметра $args

label(строка)
Название таксономии во множественном числе (для отображения в админке).
По умолчанию: используется значение аргумента $labels->name
labels(массив)

Массив описывающий заголовки таксономии (для отображения в админке).

По умолчанию используются заголовки "меток" для не древовидных типов таксономий и заголовки "категорий" для древовидных таксономий.

  • name
    Имя таксономии, обычно во множественном числе. По умолчанию _x( 'Post Tags', 'taxonomy general name' ) или _x( 'Categories', 'taxonomy general name' );

  • singular_name
    Название для одного элемента этой таксономии. По умолчанию _x( 'Post Tag', 'taxonomy singular name' ) или _x( 'Category', 'taxonomy singular name' );

  • menu_name
    Текст для названия меню. Эта строка обозначает название для пунктов меню. По умолчанию значение параметра name;

  • search_items
    Текст для поиска элемента таксономии. По умолчанию __( 'Search Tags' ) или __( 'Search Categories' );

  • popular_items
    Текст для блока популярных элементов. __( 'Popular Tags' ) или null;

  • all_items
    Текст для всех элементов. __( 'All Tags' ) или __( 'All Categories' );

  • parent_item
    Текст для родительского элемента таксономии. Этот аргумент не используется для не древовидных таксономий. По умолчанию null или __( 'Parent Category' );

  • parent_item_colon
    Текст для родительского элемента таксономии, тоже что и parent_item но с двоеточием в конце. По умолчанию нет или __( 'Parent Category:' );

  • edit_item
    Текст для редактирования элемента. По умолчанию __( 'Edit Tag' ) или __( 'Edit Category' );

  • update_item
    Текст для обновления элемента. По умолчанию __( 'Update Tag' ) или __( 'Update Category' );

  • add_new_item
    Текст для добавления нового элемента таксономии. По умолчанию __( 'Add New Tag' ) или __( 'Add New Category' );

  • view_item
    Текст для просмотра термина таксономии. По умолчанию: "Посмотреть метку", "Посмотреть категорию". Используется например, в админ баре (тулбаре).

  • new_item_name
    Текст для создания нового элемента таксономии. По умолчанию __( 'New Tag Name' ) или __( 'New Category Name' );

  • separate_items_with_commas
    Текст описывающий, что элементы нужно разделять запятыми (для блога в админке). Не работает для древовидного типа. По умолчанию __( 'Separate tags with commas' ) или null;

  • add_or_remove_items
    Текст для "удаления или добавления элемента", который используется в блоке админке, при отключенном javascript. Не действует для древовидных таксономий. По умолчанию __( 'Add or remove tags' ) или null;

  • choose_from_most_used
    текст для блога при редактировании поста "выберите из часто используемых". Не используется для древовидных таксономий. По умолчанию __( 'Choose from the most used tags' ) или null;

  • popular_items
    Текст для поиска популярных терминов. Этот параметр не используется для древовидных таксономий. По умолчанию: "Популярные метки" или null.

  • separate_items_with_commas
    Текст говорящий о том, что термины (метки) нужно разделять запятыми. Не используется для древовидных таксономий. По умолчанию: "Разделяйте метки запятыми" или null.

  • add_or_remove_items
    Текст для добавления или удаления терминов. Не используется для древовидных типов. По умолчанию: "Добавить или удалить метки". или null.

  • choose_from_most_used
    Текст "Выбрать из часто используемых". Не используется для древовидных типов.

  • not_found
    Текст "не найдено", который отображается, если при клике на часто используемые ни один термин не был найден.

Весь список смотрите в описании get_taxonomy_labels()

По умолчанию: заголовки меток/категорий

public(логический)
Показывать ли эту таксономию в интерфейсе админ-панели. Это значение передается параметрам publicly_queryable, show_ui, show_in_nav_menus если для них не установлено свое значение.
По умолчанию: true
show_ui(логический)
Показывать блок управления этой таксономией в админке.
По умолчанию: если нет, равно аргументу public
show_in_menu(логический)

Показывать ли таксономию в админ-меню.

  • true - таксономия будет показана как подменю у типа записи, к которой она прикреплена.
  • false - подменю не будет показано.

Параметр $show_ui должен быть включен (true).

По умолчанию: если нет, равно аргументу show_ui

show_in_nav_menus(логический)
true даст возможность выбирать элементы этой таксономии в навигационном меню.
По умолчанию: если нет, равно аргументу public
show_tagcloud(логический)
Создать виджет облако элементов этой таксономии (как облако меток).
По умолчанию: если нет, равно аргументу show_ui
show_in_rest(логический)
Нужно ли включать таксономию в REST API. С WP 4.7.
rest_base(строка)
Ярлык в REST API. По умолчанию, название таксономии. С WP 4.7.
По умолчанию: $taxonomy
rest_controller_class(строка)
Название класса контроллера в REST API. С WP 4.7.
По умолчанию: 'WP_REST_Terms_Controller'
hierarchical(логический)
true - таксономия будет древовидная (как категории). false - будет не древовидная (как метки).
По умолчанию: false
update_count_callback(строка)
Название функции, которая будет вызываться для обновления количества записей в данной таксономии, для типа(ов) записей которые ассоциированы с этой таксономией.
По умолчанию: нет
rewrite(массив/логический)

false - отключит перезапись. Если указать массив, то можно задать произвольный параметр запроса (query var). А по умолчанию будет использоваться параметр $taxonomy.

Возможные аргументы массива:

  • slug - предваряет таксономии этой строкой. По умолчанию название таксономии;
  • with_front - позволяет установить префикс для постоянной ссылки. По умолчанию true;
  • hierarchical - true - включает поддержку древовидных URL (с версии 3.1). По умолчанию false;

Массив передается в функцию add_permastruct(), поэтому тут также можно указать аргументы этой функции.

По умолчанию: true

publicly_queryable(логический)
Имеют ли пользователи доступ к элементам таксономии во внешней части сайта. Если не установлено, то берется значение параметра public. C версии 4.5.
По умолчанию: null (равен аргументу public)
query_var(строка/логический)
Если указать false, выключит параметры запроса и сам запрос. Или можно указать строку, чтобы изменить параметр запроса (query var). По умолчанию будет использоваться параметр $taxonomy - название таксономии.
По умолчанию: $taxonomy
capabilities(массив)

Массив прав для этой таксономии:

  • manage_terms - 'manage_categories'
  • edit_terms - 'manage_categories'
  • delete_terms - 'manage_categories'
  • assign_terms - 'edit_posts'

По умолчанию: нет

meta_box_cb(строка)

callback функция. Отвечает за то, как будет отображаться таксономия в метабоксе (с версии 3.8).

Встроенные названия функций:

  • post_categories_meta_box - показывать как категории
  • post_tags_meta_box - показывать как метки.

Если указать false, то метабокс будет отключен вообще.

По умолчанию: null

show_admin_column(логический)
Позволить или нет авто-создание колонки таксономии в таблице ассоциированного типа записи. (с версии 3.5)
По умолчанию: false
sort(логический)
Следует ли этой таксономии запоминать порядок в котором созданные элементы (термины) прикрепляются к объектам (записям).
По умолчанию: null
show_in_quick_edit(логический)
Показывать ли таксономию в панели быстрого редактирования записи (в таблице, списке всех записей, при нажатии на кнопку "свойства"). С версии 4.2.
По умолчанию: null (значение show_ui)
_builtin(логический) (не для обычного использования)
Параметр предназначен для разработчиков. Если переключить на true, то это будет означать что эта таксономия относится к внутренним таксономия WordPress и не является встроенной (кастомной).
По умолчанию: false

Примеры

#1. Регистрация таксономий

Пример регистрации двух таксономий "genres" и "writers" для постов типа "book". Этот код можно вставить в файл темы functions.php. Некоторые аргументы рассчитаны на версию 3.1+:

// хук, через который подключается функция
// регистрирующая новые таксономии (create_book_taxonomies)
add_action( 'init', 'create_book_taxonomies', 0 );

// функция, создающая 2 новые таксономии "genres" и "writers" для постов типа "book"
function create_book_taxonomies(){
	// определяем заголовки для 'genre'
	$labels = array(
		'name' => _x( 'Genres', 'taxonomy general name' ),
		'singular_name' => _x( 'Genre', 'taxonomy singular name' ),
		'search_items' =>  __( 'Search Genres' ),
		'all_items' => __( 'All Genres' ),
		'parent_item' => __( 'Parent Genre' ),
		'parent_item_colon' => __( 'Parent Genre:' ),
		'edit_item' => __( 'Edit Genre' ),
		'update_item' => __( 'Update Genre' ),
		'add_new_item' => __( 'Add New Genre' ),
		'new_item_name' => __( 'New Genre Name' ),
		'menu_name' => __( 'Genre' ),
	);

	// Добавляем древовидную таксономию 'genre' (как категории)
	register_taxonomy('genre', array('book'), array(
		'hierarchical' => true,
		'labels' => $labels,
		'show_ui' => true,
		'query_var' => true,
		'rewrite' => array( 'slug' => 'genre' ),
	));

	// определяем заголовки для 'writer'
	$labels = array(
		'name' => _x( 'Writers', 'taxonomy general name' ),
		'singular_name' => _x( 'Writer', 'taxonomy singular name' ),
		'search_items' =>  __( 'Search Writers' ),
		'popular_items' => __( 'Popular Writers' ),
		'all_items' => __( 'All Writers' ),
		'parent_item' => null,
		'parent_item_colon' => null,
		'edit_item' => __( 'Edit Writer' ),
		'update_item' => __( 'Update Writer' ),
		'add_new_item' => __( 'Add New Writer' ),
		'new_item_name' => __( 'New Writer Name' ),
		'separate_items_with_commas' => __( 'Separate writers with commas' ),
		'add_or_remove_items' => __( 'Add or remove writers' ),
		'choose_from_most_used' => __( 'Choose from the most used writers' ),
		'menu_name' => __( 'Writers' ),
	);

	// Добавляем НЕ древовидную таксономию 'writer' (как метки)
	register_taxonomy('writer', 'book',array(
		'hierarchical' => false,
		'labels' => $labels,
		'show_ui' => true,
		'query_var' => true,
		'rewrite' => array( 'slug' => 'writer' ),
	));
}

#2 Добавление таксономии в ЧПУ

Смотрите в примерах к описаниям функций: register_post_type(), WP_Rewrite

Заметки

Плагин для реги такс

Есть очень удобный, на мой взгляд, плагин который позволяет регистрировать новые типы записей и таксономии: Custom Post Type UI

Переименования названий таксономии

Код ниже, показывает как переименовать имеющуюся таксономию category (рубрики).

## Переименуем таксономию category (рубрики)
add_action( 'init', function(){
	global $wp_taxonomies;

	$labels                     = & $wp_taxonomies['category']->labels;
	$labels->name               = 'Author';
	$labels->singular_name      = 'Author';
	$labels->add_new            = 'Add Author';
	$labels->add_new_item       = 'Add Author';
	$labels->edit_item          = 'Edit Author';
	$labels->new_item           = 'Author';
	$labels->view_item          = 'View Author';
	$labels->search_items       = 'Search Authors';
	$labels->not_found          = 'No Authors found';
	$labels->not_found_in_trash = 'No Authors found in Trash';
	$labels->all_items          = 'All Authors';
	$labels->menu_name          = 'Author';
	$labels->name_admin_bar     = 'Author';

} );

Код register taxonomy: wp-includes/taxonomy.php WP 4.8.2

<?php
function register_taxonomy( $taxonomy, $object_type, $args = array() ) {
	global $wp_taxonomies;

	if ( ! is_array( $wp_taxonomies ) )
		$wp_taxonomies = array();

	$args = wp_parse_args( $args );

	if ( empty( $taxonomy ) || strlen( $taxonomy ) > 32 ) {
		_doing_it_wrong( __FUNCTION__, __( 'Taxonomy names must be between 1 and 32 characters in length.' ), '4.2.0' );
		return new WP_Error( 'taxonomy_length_invalid', __( 'Taxonomy names must be between 1 and 32 characters in length.' ) );
	}

	$taxonomy_object = new WP_Taxonomy( $taxonomy, $object_type, $args );
	$taxonomy_object->add_rewrite_rules();

	$wp_taxonomies[ $taxonomy ] = $taxonomy_object;

	$taxonomy_object->add_hooks();


	/**
	 * Fires after a taxonomy is registered.
	 *
	 * @since 3.3.0
	 *
	 * @param string       $taxonomy    Taxonomy slug.
	 * @param array|string $object_type Object type or array of object types.
	 * @param array        $args        Array of taxonomy registration arguments.
	 */
	do_action( 'registered_taxonomy', $taxonomy, $object_type, (array) $taxonomy_object );
}

Cвязанные функции

Из метки: Расширения движка addons

Еще из раздела: Любые таксономии

register_taxonomy 70 комментариев
Полезные 7 Вопросы 3 Все
  • Эдуард cайт: i-advocat.ru

    Здравствуйте, Тимур. А можно ли в WP экспортировать, а за тем импортировать пользовательские таксономии? Я так понял по умолчанию экспортируются только посты, страницы, записи пользовательских типов, категории и метки, но может какой-то плагин для этой цели имеется? Подскажите please, очень надо.

  • campusboy1837 cайт: wp-plus.ru

    Указано, что параметр show_in_quick_edit по умолчанию null, но в целом, судя по коду, если ничего не передать, то он принимает значение show_ui. Вырезка:

    // If not set, default to the setting for show_ui.
    if ( null === $args['show_in_quick_edit'] ) {
      $args['show_in_quick_edit'] = $args['show_ui'];
    }

    А ещё там в классе WP_Taxonomy все переменные обрисованы и я не понял, зачем тогда их перечислять в массиве дефолтных, как бы дублируя. Там же и написано:

    /**
     * Whether to show the taxonomy in the quick/bulk edit panel.
     *
     * @since 4.7.0
     * @access public
     * @var bool
     */
    public $show_in_quick_edit = true;
    • Kama4489

      Описание свойств это как бы педантичность. Ну, и чтобы описать каждое свойство класса... Чтобы потом можно было прочитать и понять что это за свойство или чтобы можно было отпарить класс и его свойства и методы.

      Объявление свойства в данном случае ничего не значит. Важно как они определяются дальше в коде... $show_in_quick_edit зависимое от другого... Кстати в шаблоне использования функции это было, а вот в описании параметра не было, добавил, спасибо! thank_you

      1
  • Андрей

    Кама, в вашем описании данной функции не хватает одного важного параметра - show_in_menu. Мне понадобилось скрыть пункт меню таксономии, оставив при этом возможность ее редактирования. И данный параметр как раз решает этот вопрос.
    Описание здесь: https://developer.wordpress.org/reference/functions/register_taxonomy/

    1
  • Задался вопросом: стоит ли отказаться от таксономий в пользу п/п ?

    У меня стоит фильтр записей по таксономиям, которые я вполне смог бы заменить на п/поля.

    Интересует влияние на сервер, да и вообще в целом.

  • Михаил @

    Здравствуйте. Возможно создать одну общую таксономию для для всех типов записей?

    • Да, при регистрации таксономии в строке укажите через запятую свои таксономии:

      register_taxonomy( 'name_my_tax', array( 'my_post_type_1','my_post_type_2','my_post_type_3'), $args );
      1
      • Михаил @

        Спасибо! Решил таким способом:

        add_action( 'init', 'namefunction' );
        
        function namefunction(){
        	register_taxonomy_for_object_type( 'my_tax', 'type_post');
        	register_taxonomy_for_object_type( 'my_tax', 'type_post1');
        	register_taxonomy_for_object_type( 'my_tax', 'type_post2');
        	register_taxonomy_for_object_type( 'my_tax', 'type_post3');
        	register_taxonomy_for_object_type( 'my_tax', 'type_post4');
        }
        1
  • Александр

    Добрый день. Как выводить "таксономию 'writer' (как метки)" на странице записи?

    Ответить4 месяца назад #
    • Михаил @

      Можно вывести так:

      $cur_terms = get_the_terms( $post->ID, 'таксономия' );
      	$separator   = ', ';
      foreach( $cur_terms as $category ){
      	echo 'term_id ) . '" title="' . sprintf( __( "Посмотреть все публикации от %s" ), $category->name ) . '" ' . '>';
      echo '' . $category->name .'' . $separator . '';
      }
      1
      Ответить4 месяца назад #
  • Дмитрий

    Здравствуйте.
    Есть древовидная таксономия.
    Первый уровень это область, дочерняя это город. Реально ли как -то в админке сделать так чтобы можно было выбирать только область, тоесть в качестве родительской выбирать только категорию первого уровня? и не возможность выбора города или вообще скрыть все дочернии термины.

    Ответить4 месяца назад #
  • ka2z-1 @

    Здравствуйте. Прошу помощи, задача вот такая вот у меня:

    1. Должно быть два типа страниц (в будущем может еще добавится), отличаться они будут только заголовкам в тексте (h1) и наличием одного или двух инпутов для загрузки изображения. (input type="file"). Страниц основанных на шаблонах будет 20-30...
    2. С этих страниц как гости так и зарегистрированные пользователи должны иметь возможность загружать файлы на сервер.
    3. Некоторые страницы будут доступны только зарегистрированным пользователям.
      Я не совсем понимаю как работает WP но это надо сделать в виде плагина WP.

    Если бы это было в привычных мне движках то я бы как сделал:

    1. Создал пхп страницу
    2. Подключил ее запуск из точки входа через роутинг
    3. И все)) дальше бы уже подгружал бы где надо хидеры футеры, обрабатывал бы пост запросы как мне хочется.. но ВП как то все по другом делает. В общем у меня нет проблем с реализацией функций скрипта, у меня есть проблема с запуском всего этого на WP виде плагина.
      Подскажите пожалуйста что то))
      Спасибо.
    -1
    Ответить3 месяца назад #

Здравствуйте, !

Ваш комментарий