<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[39026] trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: Docs: Add much more complete and syntactically correct documentation throughout the `WP_REST_Posts_Controller` class.</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="https://core.trac.wordpress.org/changeset/39026">39026</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/39026","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>DrewAPicture</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-10-30 17:36:15 +0000 (Sun, 30 Oct 2016)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>Docs: Add much more complete and syntactically correct documentation throughout the `WP_REST_Posts_Controller` class.
Props Soean, mrahmadawais, flixos90, DrewAPicture.
See <a href="https://core.trac.wordpress.org/ticket/38398">#38398</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2016-10-30 16:50:15 UTC (rev 39025)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2016-10-30 17:36:15 UTC (rev 39026)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,10 +1,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * REST API: WP_REST_Posts_Controller class
+ *
+ * @package WordPress
+ * @subpackage REST_API
+ * @since 4.7.0
+ */
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+/**
+ * Core class to access posts via the REST API.
+ *
+ * @since 4.7.0
+ *
+ * @see WP_REST_Controller
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> class WP_REST_Posts_Controller extends WP_REST_Controller {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Post type.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access protected
</span><span class="cx" style="display: block; padding: 0 10px"> * @var string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13,6 +28,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Instance of a post meta fields object.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
</ins><span class="cx" style="display: block; padding: 0 10px"> * @access protected
</span><span class="cx" style="display: block; padding: 0 10px"> * @var WP_REST_Post_Meta_Fields
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -21,6 +37,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Constructor.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access public
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $post_type Post type.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function __construct( $post_type ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -33,31 +52,37 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Register the routes for the objects of the controller.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Registers the routes for the objects of the controller.
+ *
+ * @since 4.7.0
+ * @access public
+ *
+ * @see register_rest_route()
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function register_routes() {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> register_rest_route( $this->namespace, '/' . $this->rest_base, array(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'methods' => WP_REST_Server::READABLE,
- 'callback' => array( $this, 'get_items' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'methods' => WP_REST_Server::READABLE,
+ 'callback' => array( $this, 'get_items' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'permission_callback' => array( $this, 'get_items_permissions_check' ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'args' => $this->get_collection_params(),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'args' => $this->get_collection_params(),
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'methods' => WP_REST_Server::CREATABLE,
- 'callback' => array( $this, 'create_item' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'methods' => WP_REST_Server::CREATABLE,
+ 'callback' => array( $this, 'create_item' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'permission_callback' => array( $this, 'create_item_permissions_check' ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::CREATABLE ),
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'schema' => array( $this, 'get_public_item_schema' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<id>[\d]+)', array(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'methods' => WP_REST_Server::READABLE,
- 'callback' => array( $this, 'get_item' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'methods' => WP_REST_Server::READABLE,
+ 'callback' => array( $this, 'get_item' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'permission_callback' => array( $this, 'get_item_permissions_check' ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'args' => array(
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'args' => array(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'context' => $this->get_context_param( array( 'default' => 'view' ) ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'password' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'The password for the post if it is password protected.' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -65,19 +90,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'methods' => WP_REST_Server::EDITABLE,
- 'callback' => array( $this, 'update_item' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'methods' => WP_REST_Server::EDITABLE,
+ 'callback' => array( $this, 'update_item' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'permission_callback' => array( $this, 'update_item_permissions_check' ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'methods' => WP_REST_Server::DELETABLE,
- 'callback' => array( $this, 'delete_item' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'methods' => WP_REST_Server::DELETABLE,
+ 'callback' => array( $this, 'delete_item' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'permission_callback' => array( $this, 'delete_item_permissions_check' ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'args' => array(
- 'force' => array(
- 'default' => false,
- 'description' => __( 'Whether to bypass trash and force deletion.' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'args' => array(
+ 'force' => array(
+ 'default' => false,
+ 'description' => __( 'Whether to bypass trash and force deletion.' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -86,10 +111,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Check if a given request has access to read /posts.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks if a given request has access to read posts.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access public
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Full details about the request.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return WP_Error|boolean
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return true|WP_Error True if the request has read access, WP_Error object otherwise.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_items_permissions_check( $request ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -103,14 +131,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Get a collection of posts.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves a collection of posts.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access public
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Full details about the request.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return WP_Error|WP_REST_Response
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_items( $request ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Make sure a search string is set in case the orderby is set to 'relevance'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Ensure a search string is set in case the orderby is set to 'relevance'.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $request['orderby'] ) && 'relevance' === $request['orderby'] && empty( $request['search'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'rest_no_search_term_defined', __( 'You need to define a search term to order by relevance.' ), array( 'status' => 400 ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -119,10 +150,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $registered = $this->get_collection_params();
</span><span class="cx" style="display: block; padding: 0 10px"> $args = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // This array defines mappings between public API query parameters whose
- // values are accepted as-passed, and their internal WP_Query parameter
- // name equivalents (some are the same). Only values which are also
- // present in $registered will be set.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * This array defines mappings between public API query parameters whose
+ * values are accepted as-passed, and their internal WP_Query parameter
+ * name equivalents (some are the same). Only values which are also
+ * present in $registered will be set.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $parameter_mappings = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'author' => 'author__in',
</span><span class="cx" style="display: block; padding: 0 10px"> 'author_exclude' => 'author__not_in',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -140,8 +173,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'status' => 'post_status',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // For each known parameter which is both registered and present in the request,
- // set the parameter's value on the query $args.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * For each known parameter which is both registered and present in the request,
+ * set the parameter's value on the query $args.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $parameter_mappings as $api_param => $wp_param ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $registered[ $api_param ], $request[ $api_param ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $args[ $wp_param ] = $request[ $api_param ];
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -149,8 +184,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Check for & assign any parameters which require special handling or setting.
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args['date_query'] = array();
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $args['date_query'] = array();
</del><span class="cx" style="display: block; padding: 0 10px"> // Set before into date query. Date query must be specified as an array of an array.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $registered['before'], $request['before'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $args['date_query'][0]['before'] = $request['before'];
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -169,21 +204,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $registered['sticky'], $request['sticky'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $sticky_posts = get_option( 'sticky_posts', array() );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $sticky_posts && $request['sticky'] ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // As post__in will be used to only get sticky posts,
- // we have to support the case where post__in was already
- // specified.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * As post__in will be used to only get sticky posts,
+ * we have to support the case where post__in was already
+ * specified.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $args['post__in'] = $args['post__in'] ? array_intersect( $sticky_posts, $args['post__in'] ) : $sticky_posts;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // If we intersected, but there are no post ids in common,
- // WP_Query won't return "no posts" for `post__in = array()`
- // so we have to fake it a bit.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * If we intersected, but there are no post ids in common,
+ * WP_Query won't return "no posts" for post__in = array()
+ * so we have to fake it a bit.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! $args['post__in'] ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $args['post__in'] = array( -1 );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> } elseif ( $sticky_posts ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // As post___not_in will be used to only get posts that
- // are not sticky, we have to support the case where post__not_in
- // was already specified.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * As post___not_in will be used to only get posts that
+ * are not sticky, we have to support the case where post__not_in
+ * was already specified.
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> $args['post__not_in'] = array_merge( $args['post__not_in'], $sticky_posts );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -192,13 +233,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $args['post_type'] = $this->post_type;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter the query arguments for a request.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters the query arguments for a request.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Enables adding extra arguments or setting defaults for a post
- * collection request.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Enables adding extra arguments or setting defaults for a post collection request.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @see https://developer.wordpress.org/reference/classes/wp_query/
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @link https://developer.wordpress.org/reference/classes/wp_query/
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $args Key value array of query var to query value.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request The request used.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -206,6 +248,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $query_args = $this->prepare_items_query( $args, $request );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $taxonomies = wp_list_filter( get_object_taxonomies( $this->post_type, 'objects' ), array( 'show_in_rest' => true ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $taxonomies as $taxonomy ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;
</span><span class="cx" style="display: block; padding: 0 10px"> $tax_exclude = $base . '_exclude';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -230,7 +273,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $posts_query = new WP_Query();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $posts_query = new WP_Query();
</ins><span class="cx" style="display: block; padding: 0 10px"> $query_result = $posts_query->query( $query_args );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Allow access to all password protected posts if the context is edit.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -239,12 +282,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $posts = array();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $query_result as $post ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $this->check_read_permission( $post ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $data = $this->prepare_item_for_response( $post, $request );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $data = $this->prepare_item_for_response( $post, $request );
</ins><span class="cx" style="display: block; padding: 0 10px"> $posts[] = $this->prepare_response_for_collection( $data );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -259,14 +303,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $total_posts < 1 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Out-of-bounds, run the query again without LIMIT for total count.
</span><span class="cx" style="display: block; padding: 0 10px"> unset( $query_args['paged'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $count_query = new WP_Query();
</span><span class="cx" style="display: block; padding: 0 10px"> $count_query->query( $query_args );
</span><span class="cx" style="display: block; padding: 0 10px"> $total_posts = $count_query->found_posts;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $max_pages = ceil( $total_posts / (int) $posts_query->query_vars['posts_per_page'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $response = rest_ensure_response( $posts );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $response = rest_ensure_response( $posts );
</del><span class="cx" style="display: block; padding: 0 10px"> $response->header( 'X-WP-Total', (int) $total_posts );
</span><span class="cx" style="display: block; padding: 0 10px"> $response->header( 'X-WP-TotalPages', (int) $max_pages );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -275,15 +320,18 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $page > 1 ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $prev_page = $page - 1;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $prev_page > $max_pages ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $prev_page = $max_pages;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $prev_link = add_query_arg( 'page', $prev_page, $base );
</span><span class="cx" style="display: block; padding: 0 10px"> $response->link_header( 'prev', $prev_link );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $max_pages > $page ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $next_page = $page + 1;
</span><span class="cx" style="display: block; padding: 0 10px"> $next_link = add_query_arg( 'page', $next_page, $base );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $response->link_header( 'next', $next_link );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -291,10 +339,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Check if a given request has access to read a post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks if a given request has access to read a post.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param WP_REST_Request $request Full details about the request.
- * @return WP_Error|boolean
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access public
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return bool|WP_Error True if the request has read access for the item, WP_Error object otherwise.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_item_permissions_check( $request ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -324,14 +375,17 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Can the user access password-protected content?
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks if the user can access password-protected content.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * This method determines whether we need to override the regular password
</span><span class="cx" style="display: block; padding: 0 10px"> * check in core with a filter.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access protected
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Post $post Post to check against.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Request data to check.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool True if the user can access password-protected content, false otherwise.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool True if the user can access password-protected content, otherwise false.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function can_access_password_content( $post, $request ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $post->post_password ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -354,20 +408,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Get a single post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves a single post.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access public
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Full details about the request.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return WP_Error|WP_REST_Response
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_item( $request ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $id = (int) $request['id'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $id = (int) $request['id'];
</ins><span class="cx" style="display: block; padding: 0 10px"> $post = $this->get_post( $id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $id ) || empty( $post->ID ) || $this->post_type !== $post->post_type ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'rest_post_invalid_id', __( 'Invalid post id.' ), array( 'status' => 404 ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $data = $this->prepare_item_for_response( $post, $request );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $data = $this->prepare_item_for_response( $post, $request );
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = rest_ensure_response( $data );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_post_type_viewable( get_post_type_object( $post->post_type ) ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -378,10 +435,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Check if a given request has access to create a post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks if a given request has access to create a post.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param WP_REST_Request $request Full details about the request.
- * @return WP_Error|boolean
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access public
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return true|WP_Error True if the request has access to create items, WP_Error object otherwise.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function create_item_permissions_check( $request ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -398,14 +458,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! current_user_can( $post_type->cap->create_posts ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'rest_cannot_create', __( 'Sorry, you are not allowed to create new posts.' ), array( 'status' => rest_authorization_required_code() ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Create a single post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Creates a single post.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access public
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Full details about the request.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return WP_Error|WP_REST_Response
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function create_item( $request ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $request['id'] ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -413,12 +477,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $post = $this->prepare_item_for_database( $request );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $post ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $post;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $post->post_type = $this->post_type;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $post_id = wp_insert_post( $post, true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $post_id = wp_insert_post( $post, true );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $post_id ) ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -427,8 +492,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $post_id->add_data( array( 'status' => 400 ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> return $post_id;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $post->ID = $post_id;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $schema = $this->get_item_schema();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -452,20 +519,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $schema['properties']['template'] ) && isset( $request['template'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->handle_template( $request['template'], $post->ID );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $terms_update = $this->handle_terms( $post->ID, $request );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $terms_update ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $terms_update;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $post = $this->get_post( $post_id );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $schema['properties']['meta'] ) && isset( $request['meta'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $meta_update = $this->meta->update_value( $request['meta'], (int) $request['id'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $meta_update ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $meta_update;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $fields_update = $this->update_additional_fields_for_object( $post, $request );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $fields_update ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $fields_update;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -473,15 +545,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Fires after a single post is created or updated via the REST API.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param object $post Inserted Post object (not a WP_Post object).
- * @param WP_REST_Request $request Request object.
- * @param boolean $creating True when creating post, false when updating.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
+ *
+ * @since 4.7.0
+ *
+ * @param object $post Inserted Post object (not a WP_Post object).
+ * @param WP_REST_Request $request Request object.
+ * @param bool $creating True when creating post, false when updating.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( "rest_insert_{$this->post_type}", $post, $request, true );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_param( 'context', 'edit' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = $this->prepare_item_for_response( $post, $request );
</span><span class="cx" style="display: block; padding: 0 10px"> $response = rest_ensure_response( $response );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $response->set_status( 201 );
</span><span class="cx" style="display: block; padding: 0 10px"> $response->header( 'Location', rest_url( sprintf( '%s/%s/%d', $this->namespace, $this->rest_base, $post_id ) ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -489,10 +567,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Check if a given request has access to update a post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks if a given request has access to update a post.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param WP_REST_Request $request Full details about the request.
- * @return WP_Error|boolean
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access public
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return true|WP_Error True if the request has access to update the item, WP_Error object otherwise.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function update_item_permissions_check( $request ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -515,13 +596,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Update a single post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Updates a single post.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access public
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Full details about the request.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return WP_Error|WP_REST_Response
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function update_item( $request ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $id = (int) $request['id'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $id = (int) $request['id'];
</ins><span class="cx" style="display: block; padding: 0 10px"> $post = $this->get_post( $id );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $id ) || empty( $post->ID ) || $this->post_type !== $post->post_type ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -529,11 +613,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $post = $this->prepare_item_for_database( $request );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $post ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $post;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> // convert the post object to an array, otherwise wp_update_post will expect non-escaped input.
</span><span class="cx" style="display: block; padding: 0 10px"> $post_id = wp_update_post( (array) $post, true );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $post_id ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'db_update_error' === $post_id->get_error_code() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $post_id->add_data( array( 'status' => 500 ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -566,6 +653,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $terms_update = $this->handle_terms( $post->ID, $request );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $terms_update ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $terms_update;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -574,12 +662,14 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $schema['properties']['meta'] ) && isset( $request['meta'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $meta_update = $this->meta->update_value( $request['meta'], $post->ID );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $meta_update ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $meta_update;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $fields_update = $this->update_additional_fields_for_object( $post, $request );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $fields_update ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $fields_update;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -588,15 +678,20 @@
</span><span class="cx" style="display: block; padding: 0 10px"> do_action( "rest_insert_{$this->post_type}", $post, $request, false );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_param( 'context', 'edit' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = $this->prepare_item_for_response( $post, $request );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> return rest_ensure_response( $response );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Check if a given request has access to delete a post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks if a given request has access to delete a post.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param WP_REST_Request $request Full details about the request.
- * @return bool|WP_Error
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access public
+ *
+ * @param WP_REST_Request $request Full details about the request.
+ * @return true|WP_Error True if the request has access to delete the item, WP_Error object otherwise.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function delete_item_permissions_check( $request ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -610,13 +705,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Delete a single post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Deletes a single post.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access public
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Full details about the request.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return WP_REST_Response|WP_Error
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return WP_REST_Response|WP_Error Response object on success, or WP_Error object on failure.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function delete_item( $request ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $id = (int) $request['id'];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $id = (int) $request['id'];
</ins><span class="cx" style="display: block; padding: 0 10px"> $force = (bool) $request['force'];
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $post = $this->get_post( $id );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -626,16 +724,21 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $supports_trash = ( EMPTY_TRASH_DAYS > 0 );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'attachment' === $post->post_type ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $supports_trash = $supports_trash && MEDIA_TRASH;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter whether a post is trashable.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters whether a post is trashable.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Return false to disable trash support for the post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param boolean $supports_trash Whether the post type support trashing.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Pass false to disable trash support for the post.
+ *
+ * @since 4.7.0
+ *
+ * @param bool $supports_trash Whether the post type support trashing.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Post $post The Post object being considered for trashing support.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $supports_trash = apply_filters( "rest_{$this->post_type}_trashable", $supports_trash, $post );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -645,6 +748,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $request->set_param( 'context', 'edit' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $response = $this->prepare_item_for_response( $post, $request );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // If we're forcing, then delete permanently.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -671,8 +775,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Fires after a single post is deleted or trashed via the REST API.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Fires immediately after a single post is deleted or trashed via the REST API.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * They dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
+ *
+ * @since 4.7.0
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param object $post The deleted or trashed post.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Response $response The response data.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request The request sent to the API.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -683,25 +791,31 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Determine the allowed query_vars for a get_items() response and
- * prepare for WP_Query.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Determines the allowed query_vars for a get_items() response and prepares
+ * them for WP_Query.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param array $prepared_args Prepared WP_Query arguments.
- * @param WP_REST_Request $request Full details about the request.
- * @return array $query_args
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access protected
+ *
+ * @param array $prepared_args Optional. Prepared WP_Query arguments. Default empty array.
+ * @param WP_REST_Request $request Optional. Full details about the request.
+ * @return array Items query arguments.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function prepare_items_query( $prepared_args = array(), $request = null ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $valid_vars = array_flip( $this->get_allowed_query_vars( $request ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $query_args = array();
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $valid_vars as $var => $index ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $prepared_args[ $var ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter the query_vars used in `get_items` for the constructed query.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters the query_vars used in get_items() for the constructed query.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The dynamic portion of the hook name, $var, refers to the query_var key.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook name, `$var`, refers to the query_var key.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param mixed $prepared_args[ $var ] The query_var value.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ *
+ * @param string $var The query_var value.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $query_args[ $var ] = apply_filters( "rest_query_var-{$var}", $prepared_args[ $var ] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -719,19 +833,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Get all the WP Query vars that are allowed for the API request.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves all of the WP Query vars that are allowed for the REST API request.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param WP_REST_Request $request Full details about the request.
- * @return array
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access protected
+ *
+ * @param WP_REST_Request $request Optional. Full details about the request.
+ * @return array Allowed query variables.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function get_allowed_query_vars( $request = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> global $wp;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter the publicly allowed query vars.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters the publicly allowed query vars.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Allows adjusting of the default query vars that are made public.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array Array of allowed WP_Query query vars.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $valid_vars = apply_filters( 'query_vars', $wp->public_query_vars );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -739,7 +858,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $post_type_obj = get_post_type_object( $this->post_type );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( current_user_can( $post_type_obj->cap->edit_posts ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter the allowed 'private' query vars for authorized users.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters the allowed 'private' query vars for authorized users.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * If the user has the `edit_posts` capability, we also allow use of
</span><span class="cx" style="display: block; padding: 0 10px"> * private query parameters, which are only undesirable on the
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -748,12 +867,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * To disable anyway, use
</span><span class="cx" style="display: block; padding: 0 10px"> * `add_filter( 'rest_private_query_vars', '__return_empty_array' );`
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array $private_query_vars Array of allowed query vars for authorized users.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * }
</del><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $private = apply_filters( 'rest_private_query_vars', $wp->private_query_vars );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $valid_vars = array_merge( $valid_vars, $private );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Define our own in addition to WP's normal vars.
</span><span class="cx" style="display: block; padding: 0 10px"> $rest_valid = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'author__in',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -769,20 +891,23 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'posts_per_page',
</span><span class="cx" style="display: block; padding: 0 10px"> 'date_query',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $valid_vars = array_merge( $valid_vars, $rest_valid );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter allowed query vars for the REST API.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters allowed query vars for the REST API.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * This filter allows you to add or remove query vars from the final allowed
</span><span class="cx" style="display: block; padding: 0 10px"> * list for all requests, including unauthenticated ones. To alter the
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * vars for editors only, {@see rest_private_query_vars}.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * vars for editors only, see {@see 'rest_private_query_vars'}.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param array {
</span><span class="cx" style="display: block; padding: 0 10px"> * Array of allowed WP_Query query vars.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $allowed_query_var The query var to allow.
- * @param WP_REST_Request $request Request object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $allowed_query_var The query var to allow.
+ * @param WP_REST_Request $request Request object.
</ins><span class="cx" style="display: block; padding: 0 10px"> * }
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> $valid_vars = apply_filters( 'rest_query_vars', $valid_vars, $request );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -791,11 +916,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Check the post_date_gmt or modified_gmt and prepare any post or
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks the post_date_gmt or modified_gmt and prepare any post or
</ins><span class="cx" style="display: block; padding: 0 10px"> * modified date for single post output.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access protected
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $date_gmt GMT publication time.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string|null $date Optional, default is null. Local publication time.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string|null $date Optional. Local publication time. Default null.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @return string|null ISO8601/RFC3339 formatted datetime.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function prepare_date_response( $date_gmt, $date = null ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -814,15 +942,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Prepare a single post for create or update.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Prepares a single post for create or update.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access protected
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Request object.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return WP_Error|stdClass $prepared_post Post object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return stdClass|WP_Error Post object or WP_Error.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function prepare_item_for_database( $request ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared_post = new stdClass;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // ID.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Post ID.
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( isset( $request['id'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared_post->ID = absint( $request['id'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -864,11 +995,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Updating a post, use previous type.
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared_post->post_type = get_post_type( $request['id'] );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $post_type = get_post_type_object( $prepared_post->post_type );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Post status.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $schema['properties']['status'] ) && isset( $request['status'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $status = $this->handle_status_param( $request['status'], $post_type );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $status ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $status;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -890,6 +1023,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> list( $prepared_post->post_date, $prepared_post->post_date_gmt ) = $date_data;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Post slug.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $schema['properties']['slug'] ) && isset( $request['slug'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared_post->post_name = $request['slug'];
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -898,12 +1032,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Author.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $schema['properties']['author'] ) && ! empty( $request['author'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $post_author = (int) $request['author'];
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( get_current_user_id() !== $post_author ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $user_obj = get_userdata( $post_author );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! $user_obj ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'rest_invalid_author', __( 'Invalid author id.' ), array( 'status' => 400 ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $prepared_post->post_author = $post_author;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -929,6 +1066,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Parent.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $schema['properties']['parent'] ) && ! empty( $request['parent'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $parent = $this->get_post( (int) $request['parent'] );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $parent ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'rest_post_invalid_id', __( 'Invalid post parent id.' ), array( 'status' => 400 ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -950,12 +1088,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $schema['properties']['ping_status'] ) && ! empty( $request['ping_status'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $prepared_post->ping_status = $request['ping_status'];
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter a post before it is inserted via the REST API.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters a post before it is inserted via the REST API.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The dynamic portion of the hook name, $this->post_type, refers to post_type of the post being
- * prepared for insertion.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param stdClass $prepared_post An object representing a single post prepared
</span><span class="cx" style="display: block; padding: 0 10px"> * for inserting or updating the database.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Request object.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -965,11 +1105,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Determine validity and normalize provided status param.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Determines validity and normalizes the given status parameter.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access protected
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $post_status Post status.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param object $post_type Post type.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return WP_Error|string $post_status
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string|WP_Error Post status or WP_Error if lacking the proper permission.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function handle_status_param( $post_status, $post_type ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -999,11 +1142,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Determine the featured media based on a request param.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Determines the featured media based on a request param.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access protected
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param int $featured_media Featured Media ID.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param int $post_id Post ID.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return bool|WP_Error
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool|WP_Error Whether the post thumbnail was successfully deleted, otherwise WP_Error.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function handle_featured_media( $featured_media, $post_id ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1022,8 +1168,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Set the template for a page.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Sets the template for a page.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access public
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param string $template Page template filename.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param integer $post_id Post ID.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1036,22 +1185,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Update the post's terms from a REST request.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Updates the post's terms from a REST request.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param int $post_id The post ID to update the terms form.
- * @param WP_REST_Request $request The request object with post and terms data.
- * @return null|WP_Error WP_Error on an error assigning any of the terms.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access protected
+ *
+ * @param int $post_id The post ID to update the terms form.
+ * @param WP_REST_Request $request The request object with post and terms data.
+ * @return null|WP_Error WP_Error on an error assigning any of the terms, otherwise null.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function handle_terms( $post_id, $request ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $taxonomies = wp_list_filter( get_object_taxonomies( $this->post_type, 'objects' ), array( 'show_in_rest' => true ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $taxonomies as $taxonomy ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $request[ $base ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $terms = array_map( 'absint', $request[ $base ] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ $terms = array_map( 'absint', $request[ $base ] );
</ins><span class="cx" style="display: block; padding: 0 10px"> $result = wp_set_object_terms( $post_id, $terms, $taxonomy->name );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( is_wp_error( $result ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return $result;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1059,10 +1214,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Check if a given post type should be viewed or managed.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks if a given post type can be viewed or managed.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access protected
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param object|string $post_type Post type name or object.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return boolean Is post type allowed?
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool Whether the post type is allowed in REST.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function check_is_post_type_allowed( $post_type ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! is_object( $post_type ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1077,12 +1235,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Check if we can read a post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks if a post can be read.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Correctly handles posts with the inherit status.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access public
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param object $post Post object.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return boolean Can we read it?
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool Whether the post can be read.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function check_read_permission( $post ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $post_type = get_post_type_object( $post->post_type );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1090,7 +1251,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return false;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Can we read the post?
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Is the post readable?
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'publish' === $post->post_status || current_user_can( $post_type->cap->read_post, $post->ID ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1106,8 +1267,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $this->check_read_permission( $parent );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // If we don't have a parent, but the status is set to inherit, assume
- // it's published (as per get_post_status()).
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /*
+ * If there isn't a parent, but the status is set to inherit, assume
+ * it's published (as per get_post_status()).
+ */
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'inherit' === $post->post_status ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1116,10 +1279,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Check if we can edit a post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks if a post can be edited.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access protected
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param object $post Post object.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return boolean Can we edit it?
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool Whether the post can be edited.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function check_update_permission( $post ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $post_type = get_post_type_object( $post->post_type );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1132,10 +1298,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Check if we can create a post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks if a post can be created.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access protected
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param object $post Post object.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return boolean Can we create it?.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool Whether the post can be created.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function check_create_permission( $post ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $post_type = get_post_type_object( $post->post_type );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1148,10 +1317,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Check if we can delete a post.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Checks if a post can be deleted.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access protected
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param object $post Post object.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return boolean Can we delete it?
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return bool Whether the post can be deleted.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function check_delete_permission( $post ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $post_type = get_post_type_object( $post->post_type );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1164,14 +1336,18 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Prepare a single post output for response.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Prepares a single post output for response.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access public
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Post $post Post object.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Request object.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return WP_REST_Response $data
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return WP_REST_Response Response object.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function prepare_item_for_response( $post, $request ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $GLOBALS['post'] = $post;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> setup_postdata( $post );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $schema = $this->get_item_schema();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1229,17 +1405,21 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $schema['properties']['title'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $data['title'] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'raw' => $post->post_title,
</span><span class="cx" style="display: block; padding: 0 10px"> 'rendered' => get_the_title( $post->ID ),
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $has_password_filter = false;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $this->can_access_password_content( $post, $request ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Allow access to the post, permissions already checked before.
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'post_password_required', '__return_false' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $has_password_filter = true;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1305,6 +1485,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $schema['properties']['format'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $data['format'] = get_post_format( $post->ID );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Fill in blank post format.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $data['format'] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $data['format'] = 'standard';
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1316,8 +1497,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $taxonomies = wp_list_filter( get_object_taxonomies( $this->post_type, 'objects' ), array( 'show_in_rest' => true ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $taxonomies as $taxonomy ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $schema['properties'][ $base ] ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $terms = get_the_terms( $post, $taxonomy->name );
</span><span class="cx" style="display: block; padding: 0 10px"> $data[ $base ] = $terms ? array_values( wp_list_pluck( $terms, 'term_id' ) ) : array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1325,8 +1508,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $context = ! empty( $request['context'] ) ? $request['context'] : 'view';
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $data = $this->add_additional_fields_to_object( $data, $request );
- $data = $this->filter_response_by_context( $data, $context );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $data = $this->add_additional_fields_to_object( $data, $request );
+ $data = $this->filter_response_by_context( $data, $context );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Wrap the data in a response object.
</span><span class="cx" style="display: block; padding: 0 10px"> $response = rest_ensure_response( $data );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1334,34 +1517,38 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $response->add_links( $this->prepare_links( $post ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Filter the post data for a response.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters the post data for a response.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * The dynamic portion of the hook name, $this->post_type, refers to post_type of the post being
- * prepared for the response.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * The dynamic portion of the hook name, `$this->post_type`, refers to the post type slug.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param WP_REST_Response $response The response object.
- * @param WP_Post $post Post object.
- * @param WP_REST_Request $request Request object.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ *
+ * @param WP_REST_Response $response The response object.
+ * @param WP_Post $post Post object.
+ * @param WP_REST_Request $request Request object.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> return apply_filters( "rest_prepare_{$this->post_type}", $response, $post, $request );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Overwrite the default protected title format.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Overwrites the default protected title format.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * By default WordPress will show password protected posts with a title of
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * By default, WordPress will show password protected posts with a title of
</ins><span class="cx" style="display: block; padding: 0 10px"> * "Protected: %s", as the REST API communicates the protected status of a post
</span><span class="cx" style="display: block; padding: 0 10px"> * in a machine readable format, we remove the "Protected: " prefix.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string Protected title format.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function protected_title_format() {
</span><span class="cx" style="display: block; padding: 0 10px"> return '%s';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Prepare links for the request.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Prepares links for the request.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access protected
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Post $post Post object.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array Links for the given post.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1392,9 +1579,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( in_array( $post->post_type, array( 'post', 'page' ), true ) || post_type_supports( $post->post_type, 'comments' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $replies_url = rest_url( 'wp/v2/comments' );
</span><span class="cx" style="display: block; padding: 0 10px"> $replies_url = add_query_arg( 'post', $post->ID, $replies_url );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $links['replies'] = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'href' => $replies_url,
- 'embeddable' => true,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'href' => $replies_url,
+ 'embeddable' => true,
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1403,7 +1591,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'href' => rest_url( trailingslashit( $base ) . $post->ID . '/revisions' ),
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $post_type_obj = get_post_type_object( $post->post_type );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $post_type_obj->hierarchical && ! empty( $post->post_parent ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $links['up'] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'href' => rest_url( trailingslashit( $base ) . (int) $post->post_parent ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1414,31 +1604,37 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // If we have a featured media, add that.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $featured_media = get_post_thumbnail_id( $post->ID ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $image_url = rest_url( 'wp/v2/media/' . $featured_media );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $links['https://api.w.org/featuredmedia'] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'href' => $image_url,
</span><span class="cx" style="display: block; padding: 0 10px"> 'embeddable' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! in_array( $post->post_type, array( 'attachment', 'nav_menu_item', 'revision' ), true ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $attachments_url = rest_url( 'wp/v2/media' );
</span><span class="cx" style="display: block; padding: 0 10px"> $attachments_url = add_query_arg( 'parent', $post->ID, $attachments_url );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $links['https://api.w.org/attachment'] = array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'href' => $attachments_url,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'href' => $attachments_url,
</ins><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $taxonomies = get_object_taxonomies( $post->post_type );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $taxonomies ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $links['https://api.w.org/term'] = array();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ( $taxonomies as $tax ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $taxonomy_obj = get_taxonomy( $tax );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Skip taxonomies that are not public.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $taxonomy_obj->show_in_rest ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> continue;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $tax_base = ! empty( $taxonomy_obj->rest_base ) ? $taxonomy_obj->rest_base : $tax;
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $terms_url = add_query_arg(
</span><span class="cx" style="display: block; padding: 0 10px"> 'post',
</span><span class="cx" style="display: block; padding: 0 10px"> $post->ID,
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1457,9 +1653,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Get the Post's schema, conforming to JSON Schema.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves the post's schema, conforming to JSON Schema.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access public
+ *
+ * @return array Item schema data.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_item_schema() {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1467,9 +1666,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> '$schema' => 'http://json-schema.org/draft-04/schema#',
</span><span class="cx" style="display: block; padding: 0 10px"> 'title' => $this->post_type,
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'object',
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- /*
- * Base properties for every Post.
- */
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Base properties for every Post.
</ins><span class="cx" style="display: block; padding: 0 10px"> 'properties' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'date' => array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( "The date the object was published, in the site's timezone." ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1554,6 +1751,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $post_type_obj = get_post_type_object( $this->post_type );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $post_type_obj->hierarchical ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $schema['properties']['parent'] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'The id for the parent of the object.' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1786,9 +1984,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Get the query params for collections of attachments.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves the query params for the posts collection.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access public
+ *
+ * @return array Collection parameters.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_collection_params() {
</span><span class="cx" style="display: block; padding: 0 10px"> $params = parent::get_collection_params();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1801,6 +2002,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'format' => 'date-time',
</span><span class="cx" style="display: block; padding: 0 10px"> 'validate_callback' => 'rest_validate_request_arg',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( post_type_supports( $this->post_type, 'author' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $params['author'] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'Limit result set to posts assigned to specific authors.' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1815,24 +2017,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'sanitize_callback' => 'wp_parse_id_list',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $params['before'] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'Limit response to resources published before a given ISO8601 compliant date.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'string',
</span><span class="cx" style="display: block; padding: 0 10px"> 'format' => 'date-time',
</span><span class="cx" style="display: block; padding: 0 10px"> 'validate_callback' => 'rest_validate_request_arg',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $params['exclude'] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'Ensure result set excludes specific ids.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'array',
</span><span class="cx" style="display: block; padding: 0 10px"> 'default' => array(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'sanitize_callback' => 'wp_parse_id_list',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $params['include'] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'Limit result set to specific ids.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'array',
</span><span class="cx" style="display: block; padding: 0 10px"> 'default' => array(),
</span><span class="cx" style="display: block; padding: 0 10px"> 'sanitize_callback' => 'wp_parse_id_list',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'page' === $this->post_type || post_type_supports( $this->post_type, 'page-attributes' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $params['menu_order'] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'Limit result set to resources with a specific menu_order value.' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1841,12 +2047,14 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'validate_callback' => 'rest_validate_request_arg',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $params['offset'] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'Offset the result set by a specific number of items.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'integer',
</span><span class="cx" style="display: block; padding: 0 10px"> 'sanitize_callback' => 'absint',
</span><span class="cx" style="display: block; padding: 0 10px"> 'validate_callback' => 'rest_validate_request_arg',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $params['order'] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'Order sort attribute ascending or descending.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'string',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1854,6 +2062,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'enum' => array( 'asc', 'desc' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'validate_callback' => 'rest_validate_request_arg',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $params['orderby'] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'Sort collection by object attribute.' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'string',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1868,11 +2077,13 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'validate_callback' => 'rest_validate_request_arg',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'page' === $this->post_type || post_type_supports( $this->post_type, 'page-attributes' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $params['orderby']['enum'][] = 'menu_order';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $post_type_obj = get_post_type_object( $this->post_type );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $post_type_obj->hierarchical || 'attachment' === $this->post_type ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $params['parent'] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'Limit result set to those of particular parent ids.' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1893,6 +2104,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'type' => 'string',
</span><span class="cx" style="display: block; padding: 0 10px"> 'validate_callback' => 'rest_validate_request_arg',
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $params['status'] = array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'default' => 'publish',
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'Limit result set to posts assigned a specific status; can be comma-delimited list of status types.' ),
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1903,6 +2115,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $taxonomies = wp_list_filter( get_object_taxonomies( $this->post_type, 'objects' ), array( 'show_in_rest' => true ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> foreach ( $taxonomies as $taxonomy ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $base = ! empty( $taxonomy->rest_base ) ? $taxonomy->rest_base : $taxonomy->name;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1926,21 +2139,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Validate whether the user can query private statuses.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Validates whether the user can query private statuses.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @since 4.7.0
+ * @access public
+ *
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param mixed $value Post status.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_REST_Request $request Full details about the request.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param string $parameter
- * @return WP_Error|boolean
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param string $parameter Additional parameter to pass to validation.
+ * @return bool|WP_Error Whether the request can query private statuses, otherwise WP_Error object.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function validate_user_can_query_private_statuses( $value, $request, $parameter ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 'publish' === $value ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return rest_validate_request_arg( $value, $request, $parameter );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> $post_type_obj = get_post_type_object( $this->post_type );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( current_user_can( $post_type_obj->cap->edit_posts ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return rest_validate_request_arg( $value, $request, $parameter );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
</ins><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'rest_forbidden_status', __( 'Status is forbidden.' ), array( 'status' => rest_authorization_required_code() ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span></span></pre>
</div>
</div>
</body>
</html>