<!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>[52372] trunk: Themes: Rename public static functions in `WP_Theme_JSON_Resolver` to remove `custom_post_type` references.</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/52372">52372</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/52372","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>hellofromTonya</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2021-12-14 16:12:57 +0000 (Tue, 14 Dec 2021)</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'>Themes: Rename public static functions in `WP_Theme_JSON_Resolver` to remove `custom_post_type` references.
WordPress Core is not really custom and does not reference "custom post type" in its function naming. This commit renames 2 public static methods:
* `WP_Theme_JSON_Resolver::get_user_custom_post_type_id()` renamed to `WP_Theme_JSON_Resolver::get_user_global_styles_post_id()`.
* `WP_Theme_JSON_Resolver::get_user_data_from_custom_post_type()` renamed to `WP_Theme_JSON_Resolver:: get_user_data_from_wp_global_styles()`.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/52049">[52049]</a>, <a href="https://core.trac.wordpress.org/changeset/52051">[52051]</a>, <a href="https://core.trac.wordpress.org/changeset/52069">[52069]</a>, <a href="https://core.trac.wordpress.org/changeset/52232">[52232]</a>, <a href="https://core.trac.wordpress.org/changeset/52275">[52275]</a>, <a href="https://core.trac.wordpress.org/changeset/52364">[52364]</a>.
Props antonvlasenko, bernhard-reiter, costdev, desrosj, hellofromTonya, noisysocks, oandregal, SergeyBiryukov.
Fixes <a href="https://core.trac.wordpress.org/ticket/54517">#54517</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminsiteeditorphp">trunk/src/wp-admin/site-editor.php</a></li>
<li><a href="#trunksrcwpincludesclasswpthemejsonresolverphp">trunk/src/wp-includes/class-wp-theme-json-resolver.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswprestthemescontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php</a></li>
<li><a href="#trunktestsphpunitteststhemewpThemeJsonResolverphp">trunk/tests/phpunit/tests/theme/wpThemeJsonResolver.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminsiteeditorphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/site-editor.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/site-editor.php 2021-12-14 15:31:14 UTC (rev 52371)
+++ trunk/src/wp-admin/site-editor.php 2021-12-14 16:12:57 UTC (rev 52372)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -64,7 +64,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">-$active_global_styles_id = WP_Theme_JSON_Resolver::get_user_custom_post_type_id();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+$active_global_styles_id = WP_Theme_JSON_Resolver::get_user_global_styles_post_id();
</ins><span class="cx" style="display: block; padding: 0 10px"> $active_theme = wp_get_theme()->get_stylesheet();
</span><span class="cx" style="display: block; padding: 0 10px"> $preload_paths = array(
</span><span class="cx" style="display: block; padding: 0 10px"> array( '/wp/v2/media', 'OPTIONS' ),
</span></span></pre></div>
<a id="trunksrcwpincludesclasswpthemejsonresolverphp"></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/class-wp-theme-json-resolver.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/class-wp-theme-json-resolver.php 2021-12-14 15:31:14 UTC (rev 52371)
+++ trunk/src/wp-includes/class-wp-theme-json-resolver.php 2021-12-14 16:12:57 UTC (rev 52372)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -225,7 +225,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param WP_Theme $theme The theme object. If empty, it
</span><span class="cx" style="display: block; padding: 0 10px"> * defaults to the current theme.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $should_create_cpt Optional. Whether a new custom post
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $create_post Optional. Whether a new custom post
</ins><span class="cx" style="display: block; padding: 0 10px"> * type should be created if none are
</span><span class="cx" style="display: block; padding: 0 10px"> * found. Default false.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $post_status_filter Optional. Filter custom post type by
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -233,7 +233,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * so it only fetches published posts.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return array Custom Post Type for the user's origin config.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public static function get_user_data_from_custom_post_type( $theme, $should_create_cpt = false, $post_status_filter = array( 'publish' ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static function get_user_data_from_wp_global_styles( $theme, $create_post = false, $post_status_filter = array( 'publish' ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( ! $theme instanceof WP_Theme ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $theme = wp_get_theme();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -262,7 +262,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"> // Special case: '-1' is a results not found.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( -1 === $post_id && ! $should_create_cpt ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( -1 === $post_id && ! $create_post ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> return $user_cpt;
</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">@@ -269,7 +269,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $recent_posts = wp_get_recent_posts( $args );
</span><span class="cx" style="display: block; padding: 0 10px"> if ( is_array( $recent_posts ) && ( count( $recent_posts ) === 1 ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $user_cpt = $recent_posts[0];
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- } elseif ( $should_create_cpt ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ } elseif ( $create_post ) {
</ins><span class="cx" style="display: block; padding: 0 10px"> $cpt_post_id = wp_insert_post(
</span><span class="cx" style="display: block; padding: 0 10px"> array(
</span><span class="cx" style="display: block; padding: 0 10px"> 'post_content' => '{"version": ' . WP_Theme_JSON::LATEST_SCHEMA . ', "isGlobalStylesUserThemeJSON": true }',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -296,7 +296,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.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 WP_Theme_JSON Entity that holds user data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return WP_Theme_JSON Entity that holds styles for user data.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function get_user_data() {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( null !== self::$user ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -304,7 +304,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"> $config = array();
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $user_cpt = self::get_user_data_from_custom_post_type( wp_get_theme() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $user_cpt = self::get_user_data_from_wp_global_styles( wp_get_theme() );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( array_key_exists( 'post_content', $user_cpt ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $decoded_data = json_decode( $user_cpt['post_content'], true );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -381,12 +381,12 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return integer|null
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- public static function get_user_custom_post_type_id() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ public static function get_user_global_styles_post_id() {
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( null !== self::$user_custom_post_type_id ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return self::$user_custom_post_type_id;
</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">- $user_cpt = self::get_user_data_from_custom_post_type( wp_get_theme(), true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $user_cpt = self::get_user_data_from_wp_global_styles( wp_get_theme(), true );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( array_key_exists( 'ID', $user_cpt ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> self::$user_custom_post_type_id = $user_cpt['ID'];
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswprestthemescontrollerphp"></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-themes-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-themes-controller.php 2021-12-14 15:31:14 UTC (rev 52371)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-themes-controller.php 2021-12-14 16:12:57 UTC (rev 52372)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -318,9 +318,9 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( $theme->get_stylesheet() === wp_get_theme()->get_stylesheet() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // This creates a record for the current theme if not existent.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $id = WP_Theme_JSON_Resolver::get_user_custom_post_type_id();
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $id = WP_Theme_JSON_Resolver::get_user_global_styles_post_id();
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $user_cpt = WP_Theme_JSON_Resolver::get_user_data_from_custom_post_type( $theme );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $user_cpt = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( $theme );
</ins><span class="cx" style="display: block; padding: 0 10px"> $id = isset( $user_cpt['ID'] ) ? $user_cpt['ID'] : null;
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunktestsphpunitteststhemewpThemeJsonResolverphp"></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/theme/wpThemeJsonResolver.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/tests/phpunit/tests/theme/wpThemeJsonResolver.php 2021-12-14 15:31:14 UTC (rev 52371)
+++ trunk/tests/phpunit/tests/theme/wpThemeJsonResolver.php 2021-12-14 16:12:57 UTC (rev 52372)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -321,25 +321,25 @@
</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">- function test_get_user_data_from_custom_post_type_does_not_use_uncached_queries() {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ function test_get_user_data_from_wp_global_styles_does_not_use_uncached_queries() {
</ins><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'query', array( $this, 'filter_db_query' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> $query_count = count( $this->queries );
</span><span class="cx" style="display: block; padding: 0 10px"> for ( $i = 0; $i < 3; $i++ ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- WP_Theme_JSON_Resolver::get_user_data_from_custom_post_type( wp_get_theme() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( wp_get_theme() );
</ins><span class="cx" style="display: block; padding: 0 10px"> WP_Theme_JSON_Resolver::clean_cached_data();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $query_count = count( $this->queries ) - $query_count;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $this->assertEquals( 1, $query_count, 'Only one SQL query should be peformed for multiple invocations of WP_Theme_JSON_Resolver::get_user_data_from_custom_post_type()' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $this->assertEquals( 1, $query_count, 'Only one SQL query should be peformed for multiple invocations of WP_Theme_JSON_Resolver::get_global_styles_from_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">- $user_cpt = WP_Theme_JSON_Resolver::get_user_data_from_custom_post_type( wp_get_theme() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $user_cpt = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( wp_get_theme() );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertEmpty( $user_cpt );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $user_cpt = WP_Theme_JSON_Resolver::get_user_data_from_custom_post_type( wp_get_theme(), true );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $user_cpt = WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( wp_get_theme(), true );
</ins><span class="cx" style="display: block; padding: 0 10px"> $this->assertNotEmpty( $user_cpt );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> $query_count = count( $this->queries );
</span><span class="cx" style="display: block; padding: 0 10px"> for ( $i = 0; $i < 3; $i++ ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- WP_Theme_JSON_Resolver::get_user_data_from_custom_post_type( wp_get_theme() );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ WP_Theme_JSON_Resolver::get_user_data_from_wp_global_styles( wp_get_theme() );
</ins><span class="cx" style="display: block; padding: 0 10px"> WP_Theme_JSON_Resolver::clean_cached_data();
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $query_count = count( $this->queries ) - $query_count;
</span></span></pre>
</div>
</div>
</body>
</html>