<!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>[2984] sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer: developer.wordpress.org: Prevent overzealous auto-linking of hash parameter text.</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 { 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="http://meta.trac.wordpress.org/changeset/2984">2984</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/2984","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>coffee2code</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-04-19 20:15:57 +0000 (Tue, 19 Apr 2016)</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'>developer.wordpress.org: Prevent overzealous auto-linking of hash parameter text.
Currently, hash params are part of the description text of a single parameter and are not true sub-parameters, so auto-linking the entire hash notation text blob can affect non-description aspects of hash elements (namely when a class is the expected datatype for a hash element) and mess up hash formatting.
* Move `param_formatting_fixup()` to inc/formatting.php.
* Rename `param_formatting_fixup() to `fix_param_hash_formatting()`.
* In `autolink_references()`, don't autolink hash notation text blobs.
* Filter param description text with `fix_param_hash_formatting()` via filter rather than direct call in content-reference template.
* Call `autolink_references()` within `fix_param_hash_formatting()` for hash param item descriptions.
See https://wordpress.slack.com/archives/meta/p1460967552000043
See https://developer.wordpress.org/reference/classes/wp_customize_control/__construct/</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdevelopercontentreferencephp">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/content-reference.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperincformattingphp">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/formatting.php</a></li>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperinctemplatetagsphp">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/template-tags.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdevelopercontentreferencephp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/content-reference.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/content-reference.php 2016-04-19 20:09:35 UTC (rev 2983)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/content-reference.php 2016-04-19 20:15:57 UTC (rev 2984)
</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 class="required"><?php printf( __( '(%s)', 'wporg' ), esc_html( $param['required'] ) ); ?></span>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php endif; ?>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php if ( ! empty( $param['content'] ) ) : ?>
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- <span class="description"><?php echo param_formatting_fixup( wp_kses_post( $param['content'] ) ); ?></span>
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ <span class="description"><?php echo wp_kses_post( $param['content'] ); ?></span>
</ins><span class="cx" style="display: block; padding: 0 10px"> <?php endif; ?>
</span><span class="cx" style="display: block; padding: 0 10px"> </p>
</span><span class="cx" style="display: block; padding: 0 10px"> <?php if ( ! empty( $param['default'] ) ) : ?>
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperincformattingphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/formatting.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/formatting.php 2016-04-19 20:09:35 UTC (rev 2983)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/formatting.php 2016-04-19 20:15:57 UTC (rev 2984)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -31,6 +31,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'the_content', array( __CLASS__, 'autolink_references' ), 11 );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'devhub-format-description', array( __CLASS__, 'autolink_references' ) );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_filter( 'devhub-format-description', array( __CLASS__, 'fix_param_hash_formatting' ), 9 );
</ins><span class="cx" style="display: block; padding: 0 10px"> add_action( 'the_content', array( __CLASS__, 'fix_unintended_markdown' ) );
</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">@@ -255,6 +256,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function autolink_references( $text ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Temporary: Don't do anything if the text is a hash notation string.
+ if ( '{' === $text[0] ) {
+ return $text;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> $r = '';
</span><span class="cx" style="display: block; padding: 0 10px"> $textarr = preg_split( '/(<[^<>]+>)/', $text, -1, PREG_SPLIT_DELIM_CAPTURE ); // split out HTML tags
</span><span class="cx" style="display: block; padding: 0 10px"> $nested_code_pre = 0; // Keep track of how many levels link is nested inside <pre> or <code>
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -385,6 +391,88 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return preg_replace( '#(<a([ \r\n\t]+[^>]+?>|>))<a [^>]+?>([^>]+?)</a></a>#i', "$1$3</a>", $r );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ /**
+ * Formats the output of params defined using hash notation.
+ *
+ * This is a temporary measure until the parser parses the hash notation
+ * into component elements that the theme could then handle and style
+ * properly.
+ *
+ * Also, as a stopgap this is going to begin as a barebones hack to simply
+ * keep the text looking like one big jumble.
+ *
+ * @param string $text The content for the param.
+ * @return string
+ */
+ function fix_param_hash_formatting( $text ) {
+ // Don't do anything if this isn't a hash notation string.
+ if ( '{' != $text[0] ) {
+ return $text;
+ }
+
+ $new_text = '';
+ $text = trim( substr( $text, 1, -1 ) );
+ $text = str_replace( '@type', "\n@type", $text );
+
+ $in_list = false;
+ $parts = explode( "\n", $text );
+ foreach ( $parts as $part ) {
+ $part = preg_replace( '/\s+/', ' ', $part );
+ list( $wordtype, $type, $name, $description ) = explode( ' ', $part, 4 );
+ $description = trim( $description );
+ $description = self::autolink_references( $description );
+
+ $skip_closing_li = false;
+
+ // Handle nested hashes.
+ if ( '{' === $description[0] || '{' === $name ) {
+ $description = ltrim( $description, '{' ) . '<ul class="param-hash">';
+ $skip_closing_li = true;
+ } elseif ( '}' === substr( $description, -1 ) ) {
+ $description = substr( $description, 0, -1 ) . "</li></ul>\n";
+ }
+
+ if ( '@type' != $wordtype ) {
+ if ( $in_list ) {
+ $in_list = false;
+ $new_text .= "</li></ul>\n";
+ }
+
+ $new_text .= $part;
+ } else {
+ if ( $in_list ) {
+ $new_text .= '<li>';
+ } else {
+ $new_text .= '<ul class="param-hash"><li>';
+ $in_list = true;
+ }
+
+ // Normalize argument name.
+ if ( $name === '{' ) {
+ // No name is specified, generally indicating an array of arrays.
+ $name = '';
+ } else {
+ // The name is defined as a variable, so remove the leading '$'.
+ $name = ltrim( $name, '$' );
+ }
+ if ( $name ) {
+ $new_text .= "<b>'{$name}'</b><br />";
+ }
+ $new_text .= "<i><span class='type'>({$type})</span></i> {$description}";
+ if ( ! $skip_closing_li ) {
+ $new_text .= '</li>';
+ }
+ $new_text .= "\n";
+ }
+ }
+
+ if ( $in_list ) {
+ $new_text .= "</li></ul>\n";
+ }
+
+ return $new_text;
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> } // DevHub_Formatting
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> DevHub_Formatting::init();
</span></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperinctemplatetagsphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/template-tags.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/template-tags.php 2016-04-19 20:09:35 UTC (rev 2983)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/template-tags.php 2016-04-19 20:15:57 UTC (rev 2984)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1190,87 +1190,6 @@
</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">- * Formats the output of params defined using hash notation.
- *
- * This is a temporary measure until the parser parses the hash notation
- * into component elements that the theme could then handle and style
- * properly.
- *
- * Also, as a stopgap this is going to begin as a barebones hack to simply
- * keep the text looking like one big jumble.
- *
- * @param string $text The content for the param.
- * @return string
- */
- function param_formatting_fixup( $text ) {
- // Don't do anything if this isn't a hash notation string.
- if ( '{' != $text[0] ) {
- return $text;
- }
-
- $new_text = '';
- $text = trim( substr( $text, 1, -1 ) );
- $text = str_replace( '@type', "\n@type", $text );
-
- $in_list = false;
- $parts = explode( "\n", $text );
- foreach ( $parts as $part ) {
- $part = preg_replace( '/\s+/', ' ', $part );
- list( $wordtype, $type, $name, $description ) = explode( ' ', $part, 4 );
- $description = trim( $description );
-
- $skip_closing_li = false;
-
- // Handle nested hashes.
- if ( '{' === $description[0] || '{' === $name ) {
- $description = ltrim( $description, '{' ) . '<ul class="param-hash">';
- $skip_closing_li = true;
- } elseif ( '}' === substr( $description, -1 ) ) {
- $description = substr( $description, 0, -1 ) . "</li></ul>\n";
- }
-
- if ( '@type' != $wordtype ) {
- if ( $in_list ) {
- $in_list = false;
- $new_text .= "</li></ul>\n";
- }
-
- $new_text .= $part;
- } else {
- if ( $in_list ) {
- $new_text .= '<li>';
- } else {
- $new_text .= '<ul class="param-hash"><li>';
- $in_list = true;
- }
-
- // Normalize argument name.
- if ( $name === '{' ) {
- // No name is specified, generally indicating an array of arrays.
- $name = '';
- } else {
- // The name is defined as a variable, so remove the leading '$'.
- $name = ltrim( $name, '$' );
- }
- if ( $name ) {
- $new_text .= "<b>'{$name}'</b><br />";
- }
- $new_text .= "<i><span class='type'>({$type})</span></i> {$description}";
- if ( ! $skip_closing_li ) {
- $new_text .= '</li>';
- }
- $new_text .= "\n";
- }
- }
-
- if ( $in_list ) {
- $new_text .= "</li></ul>\n";
- }
-
- return $new_text;
- }
-
- /**
</del><span class="cx" style="display: block; padding: 0 10px"> * Should the search bar be shown?
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return bool True if search bar should be shown.
</span></span></pre>
</div>
</div>
</body>
</html>