WP_REST_Terms_Controller

Hooks 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

• __construct()Constructor.
• register_routes()Registers the routes for terms.
• check_read_terms_permission_for_post()Checks if the terms for a post can be read.
• get_items_permissions_check()Checks if a request has access to read terms in the specified taxonomy.
• get_items()Retrieves terms associated with a taxonomy.
• get_term()Get the term, if the ID is valid.
• get_item_permissions_check()Checks if a request has access to read or edit the specified term.
• get_item()Gets a single term from a taxonomy.
• create_item_permissions_check()Checks if a request has access to create a term.
• create_item()Creates a single term in a taxonomy.
• update_item_permissions_check()Checks if a request has access to update the specified term.
• update_item()Updates a single term from a taxonomy.
• delete_item_permissions_check()Checks if a request has access to delete the specified term.
• delete_item()Deletes a single term from a taxonomy.
• prepare_item_for_database()Prepares a single term for create or update.
• prepare_item_for_response()Prepares a single term output for response.
• prepare_links()Prepares links for the request.
• get_item_schema()Retrieves the term's schema, conforming to JSON Schema.
• get_collection_params()Retrieves the query params for collections.
• check_is_taxonomy_allowed()Checks that the taxonomy is valid.

Source

View on Trac ↗View on GitHub ↗

17class WP_REST_Terms_Controller extends WP_REST_Controller {18 19	/**20	 * Taxonomy key.21	 *22	 * @since 4.7.023	 * @var string24	 */25	protected $taxonomy;26 27	/**28	 * Instance of a term meta fields object.29	 *30	 * @since 4.7.031	 * @var WP_REST_Term_Meta_Fields32	 */33	protected $meta;34 35	/**36	 * Column to have the terms be sorted by.37	 *38	 * @since 4.7.039	 * @var string40	 */41	protected $sort_column;42 43	/**44	 * Number of terms that were found.45	 *46	 * @since 4.7.047	 * @var int48	 */49	protected $total_terms;50 51	/**52	 * Whether the controller supports batching.53	 *54	 * @since 5.9.055	 * @var array56	 */57	protected $allow_batch = array( 'v1' => true );58 59	/**60	 * Constructor.61	 *62	 * @since 4.7.063	 *64	 * @param string $taxonomy Taxonomy key.65	 */66	public function __construct( $taxonomy ) {67		$this->taxonomy  = $taxonomy;68		$tax_obj         = get_taxonomy( $taxonomy );69		$this->rest_base = ! empty( $tax_obj->rest_base ) ? $tax_obj->rest_base : $tax_obj->name;70		$this->namespace = ! empty( $tax_obj->rest_namespace ) ? $tax_obj->rest_namespace : 'wp/v2';71 72		$this->meta = new WP_REST_Term_Meta_Fields( $taxonomy );73	}74 75	/**76	 * Registers the routes for terms.77	 *78	 * @since 4.7.079	 *80	 * @see register_rest_route()81	 */82	public function register_routes() {83 84		register_rest_route(85			$this->namespace,86			'/' . $this->rest_base,87			array(88				array(89					'methods'             => WP_REST_Server::READABLE,90					'callback'            => array( $this, 'get_items' ),91					'permission_callback' => array( $this, 'get_items_permissions_check' ),92					'args'                => $this->get_collection_params(),93				),94				array(95					'methods'             => WP_REST_Server::CREATABLE,96					'callback'            => array( $this, 'create_item' ),

History

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.