<!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>[54411] trunk/src/wp-includes/class-wp-theme-json.php: Docs: Various docblock fixes in `WP_Theme_JSON` class, as per documentation standards.</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/54411">54411</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/54411","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>audrasjb</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-10-07 11:59:18 +0000 (Fri, 07 Oct 2022)</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: Various docblock fixes in `WP_Theme_JSON` class, as per documentation standards.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/54408">[54408]</a>.
See <a href="https://core.trac.wordpress.org/ticket/55646">#55646</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesclasswpthemejsonphp">trunk/src/wp-includes/class-wp-theme-json.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesclasswpthemejsonphp"></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.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.php 2022-10-07 09:58:32 UTC (rev 54410)
+++ trunk/src/wp-includes/class-wp-theme-json.php 2022-10-07 11:59:18 UTC (rev 54411)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -683,7 +683,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $selector Original selector.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $to_append Selector to append.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $position A position sub-selector should be appended. Default 'right'.
</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 The new selector.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected static function append_to_selector( $selector, $to_append, $position = 'right' ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $new_selectors = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -799,7 +799,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $tree Input to process.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $schema Schema to adhere to.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array Returns the modified $tree.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array The modified $tree.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected static function remove_keys_not_in_schema( $tree, $schema ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $tree = array_intersect_key( $tree, $schema );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -865,7 +865,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * - `styles`: only the styles section in theme.json.
</span><span class="cx" style="display: block; padding: 0 10px"> * - `presets`: only the classes for the presets.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $origins A list of origins to include. By default it includes VALID_ORIGINS.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string Stylesheet.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string The resulting stylesheet.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public function get_stylesheet( $types = array( 'variables', 'styles', 'presets' ), $origins = null ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( null === $origins ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1011,12 +1011,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">- * Get the CSS layout rules for a particular block from theme.json layout definitions.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Gets the CSS layout rules for a particular block from theme.json layout definitions.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 6.1.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $block_metadata Metadata about the block to get styles for.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @return string Layout styles for the block.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected function get_layout_styles( $block_metadata ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1286,7 +1285,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param string $selector CSS selector.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $declarations List of declarations.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return string CSS ruleset.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return string The resulting CSS ruleset.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected static function to_ruleset( $selector, $declarations ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( empty( $declarations ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1304,7 +1303,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">- * Given a settings array, it returns the generated rulesets
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Given a settings array, returns the generated rulesets
</ins><span class="cx" style="display: block; padding: 0 10px"> * for the preset classes.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.8.0
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1477,7 +1476,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">- * Transform a slug into a CSS Custom Property.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Transforms a slug into a CSS Custom Property.
</ins><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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1490,7 +1489,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">- * Given the block settings, it extracts the CSS Custom Properties
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Given the block settings, extracts the CSS Custom Properties
</ins><span class="cx" style="display: block; padding: 0 10px"> * for the presets and adds them to the $declarations array
</span><span class="cx" style="display: block; padding: 0 10px"> * following the format:
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1504,7 +1503,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $settings Settings to process.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $origins List of origins to process.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array Returns the modified $declarations.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array The modified $declarations.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected static function compute_preset_vars( $settings, $origins ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $declarations = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1522,7 +1521,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">- * Given an array of settings, it extracts the CSS Custom Properties
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Given an array of settings, extracts the CSS Custom Properties
</ins><span class="cx" style="display: block; padding: 0 10px"> * for the custom values and adds them to the $declarations
</span><span class="cx" style="display: block; padding: 0 10px"> * array following the format:
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1534,7 +1533,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $settings Settings to process.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @return array Returns the modified $declarations.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @return array The modified $declarations.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected static function compute_theme_vars( $settings ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $declarations = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1791,7 +1790,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $theme_json The tree to extract setting nodes from.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $selectors List of selectors per block.
</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">+ * @return array An array of setting nodes metadata.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected static function get_setting_nodes( $theme_json, $selectors = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $nodes = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1845,7 +1844,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $theme_json The tree to extract style nodes from.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $selectors List of selectors per block.
</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">+ * @return array An array of style nodes metadata.
</ins><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> protected static function get_style_nodes( $theme_json, $selectors = array() ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $nodes = array();
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2231,7 +2230,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">- * Merge new incoming data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Merges new incoming data.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.9.0 Duotone preset also has origins.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2350,7 +2349,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">- * Returns whether a presets should be overridden or not.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Determines whether a presets should be overridden or not.
</ins><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"> * @deprecated 6.0.0 Use {@see 'get_metadata_boolean'} instead.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -2438,7 +2437,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">- * Get a `default`'s preset name by a provided slug.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Gets a `default`'s preset name by a provided slug.
</ins><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></span></pre>
</div>
</div>
</body>
</html>