rest_{$this->post_type}_trashable WordPress Filter Hook

The rest_{$this->post_type}_trashable hook allows you to trash any number of posts of a given post type. This hook is useful for when you want to move posts to the trash en masse, for example when you're deleting a large number of posts that are no longer needed. To use this hook, you need to pass it an array of post IDs that you want to trash. It will then return a boolean value indicating whether or not the trashing was successful.

apply_filters( "rest_{$this->post_type}_trashable", bool $supports_trash, WP_Post $post ) #

Filters whether a post is trashable.


Description

The dynamic portion of the hook name, $this->post_type, refers to the post type slug.

Possible hook names include:

  • rest_post_trashable
  • rest_page_trashable
  • rest_attachment_trashable

Pass false to disable Trash support for the post.


Top ↑

Parameters

$supports_trash

(bool)Whether the post type support trashing.

$post

(WP_Post)The Post object being considered for trashing support.


Top ↑

Source

File: wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

View on Trac



Top ↑

Changelog

Changelog
VersionDescription
4.7.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.