<!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>[53053] trunk/src/wp-includes: Docs: Further remove HTML markup from various function summaries.</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/53053">53053</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/53053","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2022-04-02 13:53:06 +0000 (Sat, 02 Apr 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: Further remove HTML markup from various function summaries.
Per the [https://developer.wordpress.org/coding-standards/inline-documentation-standards/php/#summary-formerly-short-description WordPress PHP documentation standards], no HTML markup or Markdown of any kind should be used in the summary. This ensures that the summary is displayed correctly in the [https://developer.wordpress.org/reference/ WordPress Code Reference].
This commit also improves formatting of HTML special characters in descriptions in `wp-includes/formatting.php`.
Follow-up to <a href="https://core.trac.wordpress.org/changeset/53048">[53048]</a>.
Props johnbillion, mukesh27.
Fixes <a href="https://core.trac.wordpress.org/ticket/55506">#55506</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpincludesembedphp">trunk/src/wp-includes/embed.php</a></li>
<li><a href="#trunksrcwpincludesformattingphp">trunk/src/wp-includes/formatting.php</a></li>
<li><a href="#trunksrcwpincludesfunctionswpscriptsphp">trunk/src/wp-includes/functions.wp-scripts.php</a></li>
<li><a href="#trunksrcwpincludesrestapiendpointsclasswpresturldetailscontrollerphp">trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.php</a></li>
<li><a href="#trunksrcwpincludesthemephp">trunk/src/wp-includes/theme.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpincludesembedphp"></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/embed.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/embed.php 2022-04-01 20:08:30 UTC (rev 53052)
+++ trunk/src/wp-includes/embed.php 2022-04-02 13:53:06 UTC (rev 53053)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -328,7 +328,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">- * Adds oEmbed discovery links in the website <head>.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Adds oEmbed discovery links in the head element of the website.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 4.4.0
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span></span></pre></div>
<a id="trunksrcwpincludesformattingphp"></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/formatting.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/formatting.php 2022-04-01 20:08:30 UTC (rev 53052)
+++ trunk/src/wp-includes/formatting.php 2022-04-02 13:53:06 UTC (rev 53053)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -374,8 +374,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Searches for disabled element tags. Pushes element to stack on tag open
</span><span class="cx" style="display: block; padding: 0 10px"> * and pops on tag close.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Assumes first char of $text is tag opening and last char is tag closing.
- * Assumes second char of $text is optionally '/' to indicate closing as in </html>.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Assumes first char of `$text` is tag opening and last char is tag closing.
+ * Assumes second char of `$text` is optionally `/` to indicate closing as in `</html>`.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.9.0
</span><span class="cx" style="display: block; padding: 0 10px"> * @access private
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -429,7 +429,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * A group of regex replaces used to identify text formatted with newlines and
</span><span class="cx" style="display: block; padding: 0 10px"> * replace double line breaks with HTML paragraph tags. The remaining line breaks
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * after conversion become <<br />> tags, unless $br is set to '0' or 'false'.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * after conversion become `<br />` tags, unless `$br` is set to '0' or 'false'.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 0.71
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -909,10 +909,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Converts a number of special characters into their HTML entities.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Specifically deals with: &, <, >, ", and '.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Specifically deals with: `&`, `<`, `>`, `"`, and `'`.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * $quote_style can be set to ENT_COMPAT to encode " to
- * ", or ENT_QUOTES to do both. Default is ENT_NOQUOTES where no quotes are encoded.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * `$quote_style` can be set to ENT_COMPAT to encode `"` to
+ * `"`, or ENT_QUOTES to do both. Default is ENT_NOQUOTES where no quotes are encoded.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 1.2.2
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 5.5.0 `$quote_style` also accepts `ENT_XML1`.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -994,10 +994,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Converts a number of HTML entities into their special characters.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Specifically deals with: &, <, >, ", and '.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Specifically deals with: `&`, `<`, `>`, `"`, and `'`.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * $quote_style can be set to ENT_COMPAT to decode " entities,
- * or ENT_QUOTES to do both " and '. Default is ENT_NOQUOTES where no quotes are decoded.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * `$quote_style` can be set to ENT_COMPAT to decode `"` entities,
+ * or ENT_QUOTES to do both `"` and `'`. Default is ENT_NOQUOTES where no quotes are decoded.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.0
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -4510,10 +4510,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"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Escapes single quotes, htmlspecialchar " < > &, and fixes line endings.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Escapes single quotes, `"`, `<`, `>`, `&`, and fixes line endings.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * Escapes text strings for echoing in JS. It is intended to be used for inline JS
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * (in a tag attribute, for example onclick="..."). Note that the strings have to
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * (in a tag attribute, for example `onclick="..."`). Note that the strings have to
</ins><span class="cx" style="display: block; padding: 0 10px"> * be in single quotes. The {@see 'js_escape'} filter is also applied here.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @since 2.8.0
</span></span></pre></div>
<a id="trunksrcwpincludesfunctionswpscriptsphp"></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/functions.wp-scripts.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/functions.wp-scripts.php 2022-04-01 20:08:30 UTC (rev 53052)
+++ trunk/src/wp-includes/functions.wp-scripts.php 2022-04-02 13:53:06 UTC (rev 53053)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -166,7 +166,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * as a query string for cache busting purposes. If version is set to false, a version
</span><span class="cx" style="display: block; padding: 0 10px"> * number is automatically added equal to current installed WordPress version.
</span><span class="cx" style="display: block; padding: 0 10px"> * If set to null, no version is added.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $in_footer Optional. Whether to enqueue the script before </body> instead of in the <head>.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $in_footer Optional. Whether to enqueue the script before `</body>` instead of in the `<head>`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Default 'false'.
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool Whether the script has been registered. True on success, false on failure.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -340,7 +340,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * as a query string for cache busting purposes. If version is set to false, a version
</span><span class="cx" style="display: block; padding: 0 10px"> * number is automatically added equal to current installed WordPress version.
</span><span class="cx" style="display: block; padding: 0 10px"> * If set to null, no version is added.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param bool $in_footer Optional. Whether to enqueue the script before </body> instead of in the <head>.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param bool $in_footer Optional. Whether to enqueue the script before `</body>` instead of in the `<head>`.
</ins><span class="cx" style="display: block; padding: 0 10px"> * Default 'false'.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function wp_enqueue_script( $handle, $src = '', $deps = array(), $ver = false, $in_footer = false ) {
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiendpointsclasswpresturldetailscontrollerphp"></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-url-details-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-url-details-controller.php 2022-04-01 20:08:30 UTC (rev 53052)
+++ trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-url-details-controller.php 2022-04-02 13:53:06 UTC (rev 53053)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -482,7 +482,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">- * Retrieves the head tag section.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Retrieves the head element section.
</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>
<a id="trunksrcwpincludesthemephp"></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/theme.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/theme.php 2022-04-01 20:08:30 UTC (rev 53052)
+++ trunk/src/wp-includes/theme.php 2022-04-02 13:53:06 UTC (rev 53053)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1948,7 +1948,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">- * Filters the Custom CSS Output into the <head>.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Filters the custom CSS output into the head element.
</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></span></pre>
</div>
</div>
</body>
</html>