WordPress как на ладони
Недорогой хостинг для сайтов на WordPress: wordpress.jino.ru

get_categories() WP 2.1.0

Возвращает массив объектов содержащих информацию о категориях.

Параметры передаваемые этой функции очень похожи на параметры передаваемые функции wp_list_categories() и могут быть переданы как в виде массива, так и в виде строки запроса: type=post&order=DESC.

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

$categories = get_categories( [
	'taxonomy'     => 'category',
	'type'         => 'post',
	'child_of'     => 0,
	'parent'       => '',
	'orderby'      => 'name',
	'order'        => 'ASC',
	'hide_empty'   => 1,
	'hierarchical' => 1,
	'exclude'      => '',
	'include'      => '',
	'number'       => 0,
	'pad_counts'   => false,
	// полный список параметров смотрите в описании функции http://wp-kama.ru/function/get_terms
] );

if( $categories ){
	foreach( $categories as $cat ){
		// Данные в объекте $cat

		// $cat->term_id
		// $cat->name (Рубрика 1)
		// $cat->slug (rubrika-1)
		// $cat->term_group (0)
		// $cat->term_taxonomy_id (4)
		// $cat->taxonomy (category)
		// $cat->description (Текст описания)
		// $cat->parent (0)
		// $cat->count (14)
		// $cat->object_id (2743)
		// $cat->cat_ID (4)
		// $cat->category_count (14)
		// $cat->category_description (Текст описания)
		// $cat->cat_name (Рубрика 1)
		// $cat->category_nicename (rubrika-1)
		// $cat->category_parent (0)

	}
}
Является основой для: wp_list_categories()
Работает на основе: get_terms()
✈ 1 раз = 0.005625с = очень медленно | 50000 раз = 11.98с = медленно | PHP 7.1.11, WP 4.9.5
Хуки из функции

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

$categories = get_categories( $args );

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

Полный список параметров и их значений смотрите в описании get_terms().

taxonomy(строка)
Название таксономии, которую нужно обрабатывать. Добавлено с версии 3.0.
По умолчанию: 'category'
type(строка)

Тип категорий, которые будут получены.

  • post - категории для постов (по умолчанию);
  • link - разделы ссылок.
    По умолчанию: "post"
child_of(строка)
Получить дочерние категории (включая все уровни вложенности), указанной категории. В параметре указывается ID родительской категории (категория, вложенные категории которой нужно показать).
parent(число)
Получает категории, родительская категория которых указана в этом параметре. Отличие от child_of в том, что будет показан один (только первый) уровень вложенности.
По умолчанию: ''
orderby(строка)

Сортировка полученных данных по определенным критериям. Например, по количеству постов в каждой категории или по названию категорий. Доступны следующие критерии:

  • id или term_id - по ID.
  • name - по названию. По умолчанию.
  • count - по полю count в term_taxonomy - по количеству записей.
  • slug - по альтернативному названию.
  • description - по описанию.
  • term_group - по группе.
  • parent - по полю parent.

  • include - по порядку указанному в параметре $include
  • slug__in - с версии 4.9. В порядке указанном в параметре $slug.
  • meta_value - по значению произвольного поля
  • meta_value_num - по значению произвольного поля, значение будет интерпретироваться как число, а не строка.
  • ключ "meta_query" - в параметре $meta_query мы можем указать параметры запроса по метаполям, и там же указать ключ для конкретного запроса. Этот ключ можно использовать как ключ для сортировки по соответствующему метаполю.
  • none - не сортировать

По умолчанию: "name"

order(строка)

Направление сортировки, указанной в параметре "orderby":

  • ASC - по порядку, от меньшего к большему (1, 2, 3; a, b, c);
  • DESC - в обратном порядке, от большего к меньшему (3, 2, 1; c, b, a).

По умолчанию: "ASC"

hide_empty(логический)

Получать или нет пустые категории (не имеющие записей):

  • 1 (true) - не получать пустые,
  • 0 (false) - получать пустые.

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

hierarchical(логический)
Если параметр установлен в true, то в результат будут включены пустые дочерние категории, дочерние категории которых имеют записи (непустые).
По умолчанию: true
exclude(строка/массив)
Исключить какие-либо категории из списка. Нужно указывать ID категорий через запятую или в массиве. Если этот параметр указан, параметр child_of будет отменен.
По умолчанию: ''
include(строка/массив)
Вывести списком только указанные категории. Указывать нужно ID категорий через запятую или в массиве.
По умолчанию: ''
number(число)
Лимит. Число категорий, которые будут получены. По умолчанию без ограничений - будут получены все категории.
pad_counts(логический)
Если передать true, то число которое показывает количество записей в родительских категориях будет суммой своих записей и записей из дочерних категорий.
По умолчанию: false

Примеры

#1 Выпадающий список

Для того, чтобы создать выпадающий список из категорий мы можем воспользоваться другой специальной для этой цели, функцией wp_dropdown_categories():

wp_dropdown_categories(array('hide_empty' => 0, 'name' => 'category_parent', 'orderby' => 'name', 'selected' => $category->parent, 'hierarchical' => true, 'show_option_none' => __('None')));

однако с таким подходом мы лишимся определенной гибкости в настройке списка, так как мы получи уже полностью сформированный список.

Поэтому, в некоторых случаях будет логичнее создать выпадающий список с помощью функции get_categories(). Вот пример (предполагается что нам нужно вывести подкатегории (дочерние) категории 10):

<select name="event-dropdown" onchange='document.location.href=this.options[this.selectedIndex].value;'>
 <option value=""><?php echo esc_attr('Выберите событие'); ?></option>
 <?php
  $categories=  get_categories('child_of=10');
  foreach ($categories as $category) {
	$option = '<option value="/category/archives/'.$category->category_nicename.'">';
	$option .= $category->cat_name;
	$option .= ' ('.$category->category_count.')';
	$option .= '</option>';
	echo $option;
  }
 ?>
</select>

#2 Список категорий и их описание

Этот пример покажет нам как можно вывести списком ссылки на категории, где сразу после каждой ссылки будет идти описание категории (указывается при создании/редактировании категории):

<?php
$categories = get_categories(array(
	'orderby' => 'name',
	'order' => 'ASC'
));
foreach( $categories as $category ){
	echo '<p>Category: <a href="' . get_category_link( $category->term_id ) . '" title="' . sprintf( __( "View all posts in %s" ), $category->name ) . '" ' . '>' . $category->name.'</a> </p> ';
	echo '<p> Description:'. $category->description . '</p>';
	echo '<p> Post Count: '. $category->count . '</p>';
}
?>

Заметки

  • Смотрите: get_terms() Type of arguments that can be changed.

Список изменений

С версии 2.1.0 Введена.

Код get categories: wp-includes/category.php WP 5.4.1

<?php
function get_categories( $args = '' ) {
	$defaults = array( 'taxonomy' => 'category' );
	$args     = wp_parse_args( $args, $defaults );

	/**
	 * Filters the taxonomy used to retrieve terms when calling get_categories().
	 *
	 * @since 2.7.0
	 *
	 * @param string $taxonomy Taxonomy to retrieve terms from.
	 * @param array  $args     An array of arguments. See get_terms().
	 */
	$args['taxonomy'] = apply_filters( 'get_categories_taxonomy', $args['taxonomy'], $args );

	// Back compat.
	if ( isset( $args['type'] ) && 'link' == $args['type'] ) {
		_deprecated_argument(
			__FUNCTION__,
			'3.0.0',
			sprintf(
				/* translators: 1: "type => link", 2: "taxonomy => link_category" */
				__( '%1$s is deprecated. Use %2$s instead.' ),
				'<code>type => link</code>',
				'<code>taxonomy => link_category</code>'
			)
		);
		$args['taxonomy'] = 'link_category';
	}

	$categories = get_terms( $args );

	if ( is_wp_error( $categories ) ) {
		$categories = array();
	} else {
		$categories = (array) $categories;
		foreach ( array_keys( $categories ) as $k ) {
			_make_cat_compat( $categories[ $k ] );
		}
	}

	return $categories;
}

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

Из раздела: Рубрики

31 коммент
Полезные 1 Вопросы 2 Все
  • Serii

    А как вывести категории для многоязычного сайта?
    Ведь в parent можно прописать id только одного поста?

    1
    Ответить24.Июл.2019 13:26 #
    • @ Руслан

      Ты нашел ответ?я тоже столкнулся с такой проблнмой

      Ответить22.Фев.2020 07:29 #
  • Получает категории родительская категория которых равна указанному в параметре ID.

    не совсем по русски, можно немного подробнее ?

    -1
    Ответить30.Авг.2019 04:30 #
    • Kama7723

      Ну как бы вроде по русски, но чутка накручено, немного упростил описание, теперь думаю вопросов не будет.

      1
      Ответить22.Фев.2020 13:39 #
  • Dmitry

    orderby может еще принимать значение include
    Может быть полезно при выводе категорий в произвольном порядке.

    $args = array(
    	'orderby' => 'include',
    	'order' => 'ASC',
    	'include' => '5,6,7,8,29,9,10,11,12,13,14,15,16'
    );
    $categories = get_categories($args);
    foreach($categories as $category) {
    	echo  $category->cat_name;
    }
    1
    Ответить26.Фев.2020 19:29 #
    • Kama7723

      Там и другое возможно, подробнее тут. В начале параметров же сказано что подробнее надо смотреть параметры get_terms() - все это дублировать не хотелось бы, но походу надо что-то с этим делать...

      Ответить26.Фев.2020 23:25 #
  • BigDimoz19 pribylvseti.ru

    Тимур, приветствую! Вопрос! В записях (а также в тизерах гл. страницы) выводится в виде ссылок, как рубрика, так и подрубрика, в которую они добавлены (классика большинства шаблонов «ВордПресс») - <?php the_category(', ') ?>. Но как вывести только подрубрику, то есть убрать родительский элемент, оставив дочерний?

    С ув. Дмитрий

    Ответить26.Мар.2020 15:41 #