_make_cat_compat

Advertisement

Private Access Private Access

This function’s access is marked private. This means it is not intended for use by plugin or theme developers, only in other core functions. It is listed here for completeness.

Summery Summery

Updates category structure to old pre-2.3 from new taxonomy structure.

Syntax Syntax

_make_cat_compat( array|object|WP_Term $category )

Description Description

This function was added for the taxonomy support to update the new category structure with the old category one. This will maintain compatibility with plugins and themes which depend on the old key or property names.

The parameter should only be passed a variable and not create the array or object inline to the parameter. The reason for this is that parameter is passed by reference and PHP will fail unless it has the variable.

There is no return value, because everything is updated on the variable you pass to it. This is one of the features with using pass by reference in PHP.

Parameters Parameters

$category

(array|object|WP_Term) (Required) Category row object or array.

Source Source

File: wp-includes/category.php

		$category->cat_ID               = $category->term_id;
		$category->category_count       = $category->count;
		$category->category_description = $category->description;
		$category->cat_name             = $category->name;
		$category->category_nicename    = $category->slug;
		$category->category_parent      = $category->parent;
	} elseif ( is_array( $category ) && isset( $category['term_id'] ) ) {
		$category['cat_ID']               = &$category['term_id'];
		$category['category_count']       = &$category['count'];
		$category['category_description'] = &$category['description'];
		$category['cat_name']             = &$category['name'];
		$category['category_nicename']    = &$category['slug'];
		$category['category_parent']      = &$category['parent'];
	}
}

Advertisement

Changelog Changelog

Changelog
Version Description
4.4.0 The $category parameter now also accepts a WP_Term object.
2.3.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.