<!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>[7769] sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/formatting.php: developer.wordpress.org: Centralize creation of doclink link markup into new `generate_link()`.</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="http://meta.trac.wordpress.org/changeset/7769">7769</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/7769","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>2018-10-24 21:41:00 +0000 (Wed, 24 Oct 2018)</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: Centralize creation of doclink link markup into new `generate_link()`.
Also adds 'devhub-format-link-attributes' filter for adding/editing attributes used for a link.
Props pbiron.
Fixes <a href="http://meta.trac.wordpress.org/ticket/3649">#3649</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperincformattingphp">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/formatting.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<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 2018-10-24 21:17:20 UTC (rev 7768)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/formatting.php 2018-10-24 21:41:00 UTC (rev 7769)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -133,14 +133,16 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Link without linked text: {@link http://en.wikipedia.org/wiki/ISO_8601}
</span><span class="cx" style="display: block; padding: 0 10px"> if ( 1 === count( $parts ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $link = '<a href="' . esc_url( $link ) . '">' . esc_html( $link ) . '</a>';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $url = $text = $link;
</ins><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"> // Link with linked text: {@link http://codex.wordpress.org/The_Loop Use new WordPress Loop}
</span><span class="cx" style="display: block; padding: 0 10px"> else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $link = '<a href="' . esc_url( $parts[0] ) . '">' . esc_html( $parts[1] ) . '</a>';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $url = $parts[0];
+ $text = $parts[1];
</ins><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">+ $link = self::generate_link( $url, $text );
</ins><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"> // Link to an internal resource.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -164,6 +166,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @return string HTML link markup if a valid element was found.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> public static function link_internal_element( $link ) {
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $url = '';
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Link to class variable: {@see WP_Rewrite::$index}
</span><span class="cx" style="display: block; padding: 0 10px"> if ( false !== strpos( $link, '::$' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // Nothing to link to currently.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -171,19 +175,15 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Link to class method: {@see WP_Query::query()}
</span><span class="cx" style="display: block; padding: 0 10px"> elseif ( false !== strpos( $link, '::' ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $link = '<a href="' .
- get_post_type_archive_link( 'wp-parser-class' ) .
- str_replace( array( '::', '()' ), array( '/', '' ), $link ) .
- '">' . esc_html( $link ) . '</a>';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $url = get_post_type_archive_link( 'wp-parser-class' ) .
+ str_replace( array( '::', '()' ), array( '/', '' ), $link );
</ins><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"> // Link to hook: {@see 'pre_get_search_form'}
</span><span class="cx" style="display: block; padding: 0 10px"> elseif ( 1 === preg_match( '/^(?:\'|(?:‘))([\$\w-&;]+)(?:\'|(?:’))$/', $link, $hook ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $hook[1] ) ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $link = '<a href="' .
- get_post_type_archive_link( 'wp-parser-hook' ) .
- sanitize_title_with_dashes( html_entity_decode( $hook[1] ) ) . '/' .
- '">' . esc_html( $link ) . '</a>';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $url = get_post_type_archive_link( 'wp-parser-hook' ) .
+ sanitize_title_with_dashes( html_entity_decode( $hook[1] ) ) . '/';
</ins><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><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -196,24 +196,52 @@
</span><span class="cx" style="display: block; padding: 0 10px"> ||
</span><span class="cx" style="display: block; padding: 0 10px"> ( 1 === preg_match ( '/^_?[A-Z][a-zA-Z]+_\w+/', $link ) ) // Otherwise, class names start with (optional underscore, then) uppercase and have underscore
</span><span class="cx" style="display: block; padding: 0 10px"> ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $link = sprintf(
- '<a href="%s">%s</a>',
- esc_url( get_post_type_archive_link( 'wp-parser-class' ) . sanitize_key( $link ) ),
- esc_html( $link )
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $url = get_post_type_archive_link( 'wp-parser-class' ) . sanitize_key( $link );
</ins><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"> // Link to function: {@see esc_attr()}
</span><span class="cx" style="display: block; padding: 0 10px"> else {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $link = '<a href="' .
- get_post_type_archive_link( 'wp-parser-function' ) .
- sanitize_title_with_dashes( html_entity_decode( $link ) ) .
- '">' . esc_html( $link ) . '</a>';
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $url = get_post_type_archive_link( 'wp-parser-function' ) .
+ sanitize_title_with_dashes( html_entity_decode( $link ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ if ( $url ) {
+ $link = self::generate_link( $url, $link );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> return $link;
</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><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Generates a link given a URL and text.
+ *
+ * @param string $url The URL, for the link's href attribute.
+ * @param string $text The text content of the link.
+ * @return string The HTML for the link.
+ */
+ public static function generate_link( $url, $text ) {
+ /**
+ * Filters the HTML attributes applied to a link's anchor element.
+ *
+ * @param array $attrs The HTML attributes applied to the link's anchor element.
+ * @param string $url The URL for the link.
+ */
+ $attrs = (array) apply_filters( 'devhub-format-link-attributes', array( 'href' => $url ), $url );
+
+ // Make sure the filter didn't completely remove the href attribute.
+ if ( empty( $attrs['href'] ) ) {
+ $attrs['href'] = $url;
+ }
+
+ $attributes = '';
+ foreach ( $attrs as $name => $value ) {
+ $value = 'href' === $name ? esc_url( $value ) : esc_attr( $value );
+ $attributes .= sprintf( ' %s="%s"', esc_attr( $name ), $value );
+ }
+
+ return sprintf( '<a%s>%s</a>', $attributes, esc_html( $text ) );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Fixes unintended markup generated by Markdown during parsing.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * The parser interprets underscores surrounding text as Markdown indicating
</span></span></pre>
</div>
</div>
</body>
</html>