<!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>[2814] sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/formatting.php: developer.wordpress.org: Auto-link plaintext references to classes, functions, and methods.</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/2814">2814</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/2814","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-03-25 18:22:12 +0000 (Fri, 25 Mar 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: Auto-link plaintext references to classes, functions, and methods.
* Ignores references made in `<code>` blocks.
* Does not attempt to recognize references to hooks. Such references must use `{@see 'hook_name'}` syntax.
Fixes <a href="http://meta.trac.wordpress.org/ticket/1483">#1483</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 2016-03-25 18:21:11 UTC (rev 2813)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/formatting.php 2016-03-25 18:22:12 UTC (rev 2814)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -27,6 +27,9 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'the_excerpt', array( __CLASS__, 'remove_inline_internal' ) );
</span><span class="cx" style="display: block; padding: 0 10px"> add_filter( 'the_content', array( __CLASS__, 'remove_inline_internal' ) );
</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( 'the_excerpt', array( __CLASS__, 'autolink_references' ), 11 );
+ add_filter( 'the_content', array( __CLASS__, 'autolink_references' ), 11 );
+
</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">@@ -236,6 +239,151 @@
</span><span class="cx" style="display: block; padding: 0 10px"> return $text;
</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">+ /**
+ * Automatically detects inline references to parsed resources and links to them.
+ *
+ * Examples:
+ * - Functions: get_the_ID()
+ * - Classes: WP_Query
+ * - Methods: WP_Query::is_single()
+ *
+ * Note: currently there is not a reliable way to infer references to hooks. Recommend
+ * using the {@}see 'hook_name'} notation as used in the inline docs.
+ *
+ * @param string $text The text.
+ * @return string
+ */
+ public function autolink_references( $text ) {
+ $r = '';
+ $textarr = preg_split( '/(<[^<>]+>)/', $text, -1, PREG_SPLIT_DELIM_CAPTURE ); // split out HTML tags
+ $nested_code_pre = 0; // Keep track of how many levels link is nested inside <pre> or <code>
+ foreach ( $textarr as $piece ) {
+
+ if ( preg_match( '|^<code[\s>]|i', $piece ) || preg_match( '|^<pre[\s>]|i', $piece ) || preg_match( '|^<script[\s>]|i', $piece ) || preg_match( '|^<style[\s>]|i', $piece ) )
+ $nested_code_pre++;
+ elseif ( $nested_code_pre && ( '</code>' === strtolower( $piece ) || '</pre>' === strtolower( $piece ) || '</script>' === strtolower( $piece ) || '</style>' === strtolower( $piece ) ) )
+ $nested_code_pre--;
+
+ if ( $nested_code_pre || empty( $piece ) || ( $piece[0] === '<' && ! preg_match( '|^<\s*[\w]{1,20}+://|', $piece ) ) ) {
+ $r .= $piece;
+ continue;
+ }
+
+ // Long strings might contain expensive edge cases ...
+ if ( 10000 < strlen( $piece ) ) {
+ // ... break it up
+ foreach ( _split_str_by_whitespace( $piece, 2100 ) as $chunk ) { // 2100: Extra room for scheme and leading and trailing paretheses
+ if ( 2101 < strlen( $chunk ) ) {
+ $r .= $chunk; // Too big, no whitespace: bail.
+ } else {
+ $r .= make_clickable( $chunk );
+ }
+ }
+ } else {
+ /*
+ * Everthing outside of this conditional block was copied from core's
+ *`make_clickable()`.
+ */
+
+ $content = " $piece "; // Pad with whitespace to simplify the regexes
+
+ // Only if the text contains something that might be a function.
+ if ( false !== strpos( $content, '()' ) ) {
+
+ // Detect references to class methods, e.g. WP_Query::query()
+ // or functions, e.g. register_post_type().
+ $content = preg_replace_callback(
+ '~
+ (?!<.*?) # Non-capturing check to ensure not matching what looks like the inside of an HTML tag.
+ ( # 1: The full method or function name.
+ ((\w+)::)? # 2: The class prefix, if a method reference.
+ (\w+) # 3: The method or function name.
+ )
+ \(\) # The () that signifies either a method or function.
+ (?![^<>]*?>) # Non-capturing check to ensure not matching what looks like the inside of an HTML tag.
+ ~x',
+ function ( $matches ) {
+ // Reference to a class method.
+ if ( $matches[2] ) {
+ // Only link actually parsed methods.
+ if ( $post = get_page_by_title( $matches[1], OBJECT, 'wp-parser-method' ) ) {
+ return sprintf(
+ '<a href="%s">%s</a>',
+ get_permalink( $post->ID ),
+ $matches[0]
+ );
+ }
+
+ // Reference to a function.
+ } else {
+ // Only link actually parsed functions.
+ if ( $post = get_page_by_title( $matches[1], OBJECT, 'wp-parser-function' ) ) {
+ return sprintf(
+ '<a href="%s">%s</a>',
+ get_permalink( $post->ID ),
+ $matches[0]
+ );
+ }
+ }
+
+ // It's not a reference to an actual thing, so restore original text.
+ return $matches[0];
+ },
+ $content
+ );
+
+ }
+
+ // Detect references to classes, e.g. WP_Query
+ $content = preg_replace_callback(
+ // Most class names start with an uppercase letter and have an underscore.
+ // The exceptions are explicitly listed since future classes likely won't violate previous statement.
+ '~'
+ . '(?<!/)'
+ . '\b' // Word boundary
+ . '(' // Primary match grouping
+ . 'wpdb|wp_atom_server|wp_xmlrpc_server extends IXR_Server' // Exceptions that start with lowercase letter
+ . '|AtomFeed|AtomEntry|AtomParser|MagpieRSS|RSSCache|Translations|Walker' // Exceptions that lack an underscore
+ . '|[A-Z][a-zA-Z]+_\w+' // Most start with uppercase, has underscore
+ . ')' // End primary match grouping
+ . '\b' // Word boundary
+ . '(?!([<:]|"|\'>))' // Does not appear within a tag
+ . '~',
+ function ( $matches ) {
+ // If match is all caps, it's not a possible class name.
+ // We'll chalk the sole exception, WP, as merely being an abbreviation (the regex won't match it anyhow).
+ if ( strtoupper( $matches[0] ) === $matches[0] ) {
+ return $matches[0];
+ }
+
+ // Only link actually parsed classes.
+ if ( $post = get_page_by_title( $matches[0], OBJECT, 'wp-parser-class' ) ) {
+ return sprintf(
+ '<a href="%s">%s</a>',
+ get_permalink( $post->ID ),
+ $matches[0]
+ );
+ }
+
+ // Not a class reference, so put the original reference back in.
+ return $matches[0];
+ },
+ $content
+ );
+
+ // Maybelater: Detect references to hooks, Currently not deemed reliably possible.
+
+ $content = substr( $content, 1, -1 ); // Remove our whitespace padding.
+ $r .= $content;
+
+ } // end else
+
+ } // end foreach
+
+ // Cleanup of accidental links within links
+ return preg_replace( '#(<a([ \r\n\t]+[^>]+?>|>))<a [^>]+?>([^>]+?)</a></a>#i', "$1$3</a>", $r );
+ }
+
</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>
</div>
</body>
</html>