<!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>[58783] trunk: REST API: Remove post status prefix from REST API responses.</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 { white-space: pre-line; 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/58783">58783</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/58783","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>youknowriad</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-07-23 07:49:54 +0000 (Tue, 23 Jul 2024)</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'>REST API: Remove post status prefix from REST API responses.
When using the /posts or /pages endpoints, for private posts or pages, you get the following title property: { raw: "Some title", rendered: "Private: Some title" }
this commit removes the prefix from rendered private posts titles (just like what we do for protected posts)
Props youknowriad, swissspidy, timothyblynjacobs, sergeybiryukov, ramonopoly.
Fixes <a href="https://core.trac.wordpress.org/ticket/61639">#61639</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestglobalstylescontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestmenuitemscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestpostscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php</a></li>
<li><a href="#trunksrcwpincludesrestapisearchclasswprestpostsearchhandlerphp">trunk/src/wp-includes/rest-api/search/class-wp-rest-post-search-handler.php</a></li>
<li><a href="#trunktestsphpunitincludestestcaserestposttypecontrollerphp">trunk/tests/phpunit/includes/testcase-rest-post-type-controller.php</a></li>
<li><a href="#trunktestsphpunittestsrestapiwpRestMenuItemsControllerphp">trunk/tests/phpunit/tests/rest-api/wpRestMenuItemsController.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesrestapiendpointsclasswprestglobalstylescontrollerphp"></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-global-styles-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-global-styles-controller.php 2024-07-23 00:25:19 UTC (rev 58782)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-global-styles-controller.php 2024-07-23 07:49:54 UTC (rev 58783)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -327,10 +327,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> if ( rest_is_field_included( 'title.rendered', $fields ) ) {
</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">+ add_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $data['title']['rendered'] = get_the_title( $post->ID );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ remove_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
</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"> if ( rest_is_field_included( 'settings', $fields ) ) {
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestmenuitemscontrollerphp"></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-menu-items-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-menu-items-controller.php 2024-07-23 00:25:19 UTC (rev 58782)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-menu-items-controller.php 2024-07-23 07:49:54 UTC (rev 58783)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -510,6 +510,7 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( rest_is_field_included( 'title.rendered', $fields ) ) {
</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">+ add_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-includes/post-template.php */
</span><span class="cx" style="display: block; padding: 0 10px"> $title = apply_filters( 'the_title', $menu_item->title, $menu_item->ID );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -517,6 +518,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $data['title']['rendered'] = $title;
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ remove_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
</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"> if ( rest_is_field_included( 'status', $fields ) ) {
</span></span></pre></div>
<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 2024-07-23 00:25:19 UTC (rev 58782)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php 2024-07-23 07:49:54 UTC (rev 58783)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1844,10 +1844,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> if ( rest_is_field_included( 'title.rendered', $fields ) ) {
</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">+ add_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $data['title']['rendered'] = get_the_title( $post->ID );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ remove_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
</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"> $has_password_filter = false;
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2047,15 +2049,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">- * Overwrites the default protected title format.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Overwrites the default protected and private 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
- * "Protected: %s", as the REST API communicates the protected status of a post
- * in a machine-readable format, we remove the "Protected: " prefix.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * By default, WordPress will show password protected or private posts with a title of
+ * "Protected: %s" or "Private: %s", as the REST API communicates the status of a post
+ * in a machine-readable format, we remove the prefix.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.7.0
</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 Protected title format.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string 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></pre></div>
<a id="trunksrcwpincludesrestapisearchclasswprestpostsearchhandlerphp"></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/search/class-wp-rest-post-search-handler.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/search/class-wp-rest-post-search-handler.php 2024-07-23 00:25:19 UTC (rev 58782)
+++ trunk/src/wp-includes/rest-api/search/class-wp-rest-post-search-handler.php 2024-07-23 07:49:54 UTC (rev 58783)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -132,8 +132,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> if ( in_array( WP_REST_Search_Controller::PROP_TITLE, $fields, true ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( post_type_supports( $post->post_type, '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">+ add_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $data[ WP_REST_Search_Controller::PROP_TITLE ] = get_the_title( $post->ID );
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ remove_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px"> $data[ WP_REST_Search_Controller::PROP_TITLE ] = '';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -183,15 +185,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">- * Overwrites the default protected title format.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Overwrites the default protected and private 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
- * "Protected: %s". As the REST API communicates the protected status of a post
- * in a machine-readable format, we remove the "Protected: " prefix.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * By default, WordPress will show password protected or private posts with a title of
+ * "Protected: %s" or "Private: %s", as the REST API communicates the status of a post
+ * in a machine-readable format, we remove the prefix.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.0.0
</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 Protected title format.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string 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></pre></div>
<a id="trunktestsphpunitincludestestcaserestposttypecontrollerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/includes/testcase-rest-post-type-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/includes/testcase-rest-post-type-controller.php 2024-07-23 00:25:19 UTC (rev 58782)
+++ trunk/tests/phpunit/includes/testcase-rest-post-type-controller.php 2024-07-23 07:49:54 UTC (rev 58783)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -107,8 +107,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Check filtered values.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( post_type_supports( $post->post_type, '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">+ add_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( get_the_title( $post->ID ), $data['title']['rendered'] );
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ remove_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'edit' === $context ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $post->post_title, $data['title']['raw'] );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span></span></pre></div>
<a id="trunktestsphpunittestsrestapiwpRestMenuItemsControllerphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/tests/phpunit/tests/rest-api/wpRestMenuItemsController.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/rest-api/wpRestMenuItemsController.php 2024-07-23 00:25:19 UTC (rev 58782)
+++ trunk/tests/phpunit/tests/rest-api/wpRestMenuItemsController.php 2024-07-23 07:49:54 UTC (rev 58783)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -862,8 +862,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> // Check filtered values.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( post_type_supports( self::POST_TYPE, '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">+ add_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $post->title, $data['title']['rendered'] );
</span><span class="cx" style="display: block; padding: 0 10px"> remove_filter( 'protected_title_format', array( $this, 'protected_title_format' ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ remove_filter( 'private_title_format', array( $this, 'protected_title_format' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( 'edit' === $context ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $this->assertSame( $post->title, $data['title']['raw'] );
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span></span></pre>
</div>
</div>
</body>
</html>