WP_REST_Posts_Controller

Hooks fired · 19

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

Properties · 4

$post_typestringprotected

Post type.

$metaWP_REST_Post_Meta_Fieldsprotected

Instance of a post meta fields object.

$password_check_passedint[]protected

Passwordless post access permitted.

$allow_batcharrayprotected

Whether the controller supports batching.

Methods · 40

• __construct()Constructor.
• register_routes()Registers the routes for posts.
• get_items_permissions_check()Checks if a given request has access to read posts.
• check_password_required()Overrides the result of the post password check for REST requested posts.
• get_items()Retrieves a collection of posts.
• get_post()Gets the post, if the ID is valid.
• get_item_permissions_check()Checks if a given request has access to read a post.
• can_access_password_content()Checks if the user can access password-protected content.
• get_item()Retrieves a single post.
• create_item_permissions_check()Checks if a given request has access to create a post.
• create_item()Creates a single post.
• update_item_permissions_check()Checks if a given request has access to update a post.
• update_item()Updates a single post.
• delete_item_permissions_check()Checks if a given request has access to delete a post.
• delete_item()Deletes a single post.
• prepare_items_query()Determines the allowed query_vars for a get_items() response and prepares them for WP_Query.
• prepare_date_response()Checks the post_date_gmt or modified_gmt and prepare any post or modified date for single post output.
• prepare_item_for_database()Prepares a single post for create or update.
• check_status()Checks whether the status is valid for the given post.
• handle_status_param()Determines validity and normalizes the given status parameter.
• handle_featured_media()Determines the featured media based on a request param.
• check_template()Checks whether the template is valid for the given post.
• handle_template()Sets the template for a post.
• handle_terms()Updates the post's terms from a REST request.
• check_assign_terms_permission()Checks whether current user can assign all terms sent with the current request.
• check_is_post_type_allowed()Checks if a given post type can be viewed or managed.
• check_read_permission()Checks if a post can be read.
• check_update_permission()Checks if a post can be edited.
• check_create_permission()Checks if a post can be created.
• check_delete_permission()Checks if a post can be deleted.
• prepare_item_for_response()Prepares a single post output for response.
• protected_title_format()Overwrites the default protected and private title format.
• prepare_links()Prepares links for the request.
• get_available_actions()Gets the link relations available for the post and current user.
• get_item_schema()Retrieves the post's schema, conforming to JSON Schema.
• get_schema_links()Retrieves Link Description Objects that should be added to the Schema for the posts collection.
• get_collection_params()Retrieves the query params for the posts collection.
• sanitize_post_statuses()Sanitizes and validates the list of post statuses, including whether the user can query private statuses.
• prepare_tax_query()Prepares the 'tax_query' for a collection of posts.
• prepare_taxonomy_limit_schema()Prepares the collection schema for including and excluding items by terms.

Source

View on Trac ↗View on GitHub ↗

17class WP_REST_Posts_Controller extends WP_REST_Controller {18	/**19	 * Post type.20	 *21	 * @since 4.7.022	 * @var string23	 */24	protected $post_type;25 26	/**27	 * Instance of a post meta fields object.28	 *29	 * @since 4.7.030	 * @var WP_REST_Post_Meta_Fields31	 */32	protected $meta;33 34	/**35	 * Passwordless post access permitted.36	 *37	 * @since 5.7.138	 * @var int[]39	 */40	protected $password_check_passed = array();41 42	/**43	 * Whether the controller supports batching.44	 *45	 * @since 5.9.046	 * @var array47	 */48	protected $allow_batch = array( 'v1' => true );49 50	/**51	 * Constructor.52	 *53	 * @since 4.7.054	 *55	 * @param string $post_type Post type.56	 */57	public function __construct( $post_type ) {58		$this->post_type = $post_type;59		$obj             = get_post_type_object( $post_type );60		$this->rest_base = ! empty( $obj->rest_base ) ? $obj->rest_base : $obj->name;61		$this->namespace = ! empty( $obj->rest_namespace ) ? $obj->rest_namespace : 'wp/v2';62 63		$this->meta = new WP_REST_Post_Meta_Fields( $this->post_type );64	}65 66	/**67	 * Registers the routes for posts.68	 *69	 * @since 4.7.070	 *71	 * @see register_rest_route()72	 */73	public function register_routes() {74 75		register_rest_route(76			$this->namespace,77			'/' . $this->rest_base,78			array(79				array(80					'methods'             => WP_REST_Server::READABLE,81					'callback'            => array( $this, 'get_items' ),82					'permission_callback' => array( $this, 'get_items_permissions_check' ),83					'args'                => $this->get_collection_params(),84				),85				array(86					'methods'             => WP_REST_Server::CREATABLE,87					'callback'            => array( $this, 'create_item' ),88					'permission_callback' => array( $this, 'create_item_permissions_check' ),89					'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),90				),91				'allow_batch' => $this->allow_batch,92				'schema'      => array( $this, 'get_public_item_schema' ),93			)94		);95 96		$schema        = $this->get_item_schema();

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 7.0.4 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-posts-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.