wppaste
WordPress

WP_REST_Terms_Controller

Since
4.7.0
Source
wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php:17
Core class used to managed terms associated with a taxonomy via the REST API.

Compatibility

WordPress
since 4.7.0
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in every tracked release (6.7.7 to 7.1.0).

Hooks and filters fired · 10

Every hook that fires from inside WP_REST_Terms_Controller, in the order it appears in the class, grouped by the method that fires it.

Properties · 5

$taxonomystringprotected
Taxonomy key.
$metaWP_REST_Term_Meta_Fieldsprotected
Instance of a term meta fields object.
$sort_columnstringprotected
Column to have the terms be sorted by.
$total_termsintprotected
Number of terms that were found.
$allow_batcharrayprotected
Whether the controller supports batching.

Methods · 20

Source code

class WP_REST_Terms_Controller extends WP_REST_Controller { 	/**	 * Taxonomy key.	 *	 * @since 4.7.0	 * @var string	 */	protected $taxonomy; 	/**	 * Instance of a term meta fields object.	 *	 * @since 4.7.0	 * @var WP_REST_Term_Meta_Fields	 */	protected $meta; 	/**	 * Column to have the terms be sorted by.	 *	 * @since 4.7.0	 * @var string	 */	protected $sort_column; 	/**	 * Number of terms that were found.	 *	 * @since 4.7.0	 * @var int	 */	protected $total_terms; 	/**	 * Whether the controller supports batching.	 *	 * @since 5.9.0	 * @var array	 */	protected $allow_batch = array( 'v1' => true ); 	/**	 * Constructor.	 *	 * @since 4.7.0	 *	 * @param string $taxonomy Taxonomy key.	 */	public function __construct( $taxonomy ) {		$this->taxonomy  = $taxonomy;		$tax_obj         = get_taxonomy( $taxonomy );		$this->rest_base = ! empty( $tax_obj->rest_base ) ? $tax_obj->rest_base : $tax_obj->name;		$this->namespace = ! empty( $tax_obj->rest_namespace ) ? $tax_obj->rest_namespace : 'wp/v2'; 		$this->meta = new WP_REST_Term_Meta_Fields( $taxonomy );	} 	/**	 * Registers the routes for terms.	 *	 * @since 4.7.0	 *	 * @see register_rest_route()	 */	public function register_routes() { 		register_rest_route(			$this->namespace,			'/' . $this->rest_base,			array(				array(					'methods'             => WP_REST_Server::READABLE,					'callback'            => array( $this, 'get_items' ),					'permission_callback' => array( $this, 'get_items_permissions_check' ),					'args'                => $this->get_collection_params(),				),				array(					'methods'             => WP_REST_Server::CREATABLE,					'callback'            => array( $this, 'create_item' ),

Changelog

Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.

  1. 6.7.7
  2. 6.8.8
  3. 6.9.7
  4. 7.0.4
  5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data
Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.
Corrections
Something wrong on this page? Report it and it gets fixed in the next regeneration.