REST API: Remove post status prefix from REST API responses #7019
Conversation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the Core Committers: Use this line as a base for the props when committing in SVN: To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
| * | ||
| * @since 4.7.0 | ||
| * | ||
| * @return string Protected title format. | ||
| * @return string Title format. | ||
| */ | ||
| public function protected_title_format() { |
There was a problem hiding this comment.
I decided to reuse the same function protected_title_format even if it has "protected" in its name. We can't rename it since it's a public function and I don't really think it's worth duplicating it.
Test using WordPress PlaygroundThe changes in this pull request can previewed and tested using a WordPress Playground instance. WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser. Some things to be aware of
For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation. |
youknowriad
requested review from
SergeyBiryukov,
swissspidy,
ramonjd and
aaronrobertshaw
| * in a machine-readable format, we remove the "Protected: " prefix. | ||
| * 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. | ||
| * | ||
| * @since 4.7.0 |
There was a problem hiding this comment.
Sorry to be pedantic, but does this change warrant a @since annotation?
There was a problem hiding this comment.
For me it doesn't, the function didn't change.
| * in a machine-readable format, we remove the "Protected: " prefix. | ||
| * 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. | ||
| * | ||
| * @since 5.0.0 |
When using the /posts or /pages, REST API, for private posts or pages, you get the following title property:
title: { raw: "Some title", rendered: "Private: Some title" }
As discussed on the trac ticket, this PR removes the prefix from private posts (just like what we do for protected posts)
Trac ticket: https://core.trac.wordpress.org/ticket/61639