<!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>[1045] sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer: developer.wordpress.org: move formatting-related code into dedicated include file</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/1045">1045</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/1045","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>2014-12-16 20:15:00 +0000 (Tue, 16 Dec 2014)</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: move formatting-related code into dedicated include file</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperfunctionsphp">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/functions.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>
<h3>Added 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_htmlwpcontentthemespubwporgdeveloperfunctionsphp"></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/functions.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/functions.php 2014-12-15 21:32:58 UTC (rev 1044)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/functions.php 2014-12-16 20:15:00 UTC (rev 1045)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -56,6 +56,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require __DIR__ . '/inc/redirects.php';
</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">+ * Content formatting.
+ */
+require __DIR__ . '/inc/formatting.php';
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Set the content width based on the theme's design and stylesheet.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! isset( $content_width ) ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -80,9 +85,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> add_theme_support( 'automatic-feed-links' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_theme_support( 'post-thumbnails' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_filter( 'the_excerpt', __NAMESPACE__ . '\\lowercase_P_dangit_just_once' );
- add_filter( 'the_content', __NAMESPACE__ . '\\make_doclink_clickable', 10, 5 );
-
</del><span class="cx" style="display: block; padding: 0 10px"> // Add the handbook's 'Watch' action link.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( class_exists( 'WPorg_Handbook_Watchlist' ) && method_exists( 'WPorg_Handbook_Watchlist', 'display_action_link' ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wporg_action_links', array( 'WPorg_Handbook_Watchlist', 'display_action_link' ) );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -421,119 +423,3 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_enqueue_script( 'wporg-developer-skip-link-focus-fix', get_template_directory_uri() . '/js/skip-link-focus-fix.js', array(), '20130115', true );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_enqueue_script( 'wporg-developer-search', get_template_directory_uri() . '/js/search.js', array(), '20141029', true );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-
-/**
- * Allows for "Wordpress" just for the excerpt value of the capital_P_dangit function.
- *
- * WP.org has a global output buffer that runs capital_P_dangit() over displayed
- * content. For this one field of this one post, circumvent that function to
- * to show the lowercase P.
- *
- * @param string $excerpt The post excerpt.
- * @return string
- */
-function lowercase_P_dangit_just_once( $excerpt ) {
- if ( 'wp-parser-function' == get_post_type() && 'capital_P_dangit' == get_the_title() ) {
- $excerpt = str_replace( 'Wordpress', 'Wordpress', $excerpt );
- }
-
- return $excerpt;
-}
-
-/**
- * Makes phpDoc @link references clickable.
- *
- * Handles these five different types of links:
- *
- * - {@link http://en.wikipedia.org/wiki/ISO_8601}
- * - {@link WP_Rewrite::$index}
- * - {@link WP_Query::query()}
- * - {@link esc_attr()}
- * - {@link http://codex.wordpress.org/The_Loop Use new WordPress Loop}
- *
- * @param string $content The content.
- * @return string
- */
-function make_doclink_clickable( $content ) {
-
- // Nothing to change unless a @link or @see reference is in the text.
- if ( false === strpos( $content, '{@link ' ) && false === strpos( $content, '{@see ' ) ) {
- return $content;
- }
-
- return preg_replace_callback(
- '/\{@(?:link|see) ([^\}]+)\}/',
- function ( $matches ) {
-
- $link = $matches[1];
-
- // Undo links made clickable during initial parsing
- if ( 0 === strpos( $link, '<a ' ) ) {
-
- if ( preg_match( '/^<a .*href=[\'\"]([^\'\"]+)[\'\"]>(.*)<\/a>(.*)$/', $link, $parts ) ) {
- $link = $parts[1];
- if ( $parts[3] ) {
- $link .= ' ' . $parts[3];
- }
- }
-
- }
-
- // Link to an external resource.
- if ( 0 === strpos( $link, 'http' ) ) {
-
- $parts = explode( ' ', $link, 2 );
-
- // Link without linked text: {@link http://en.wikipedia.org/wiki/ISO_8601}
- if ( 1 === count( $parts ) ) {
- $link = '<a href="' . esc_url( $link ) . '">' . esc_html( $link ) . '</a>';
- }
-
- // Link with linked text: {@link http://codex.wordpress.org/The_Loop Use new WordPress Loop}
- else {
- $link = '<a href="' . esc_url( $parts[0] ) . '">' . esc_html( $parts[1] ) . '</a>';
- }
-
- }
-
- // Link to an internal resource.
- else {
-
- // Link to class variable: {@link WP_Rewrite::$index}
- if ( false !== strpos( $link, '::$' ) ) {
- // Nothing to link to currently.
- }
-
- // Link to class method: {@link WP_Query::query()}
- elseif ( false !== strpos( $link, '::' ) ) {
- $link = '<a href="' .
- get_post_type_archive_link( 'wp-parser-class' ) .
- str_replace( array( '::', '()' ), array( '/', '' ), $link ) .
- '">' . esc_html( $link ) . '</a>';
- }
-
- // Link to hook: {@see 'pre_get_search_form'}
- elseif ( 1 === preg_match( '/^(‘)\w+(’)$/', $link, $hook ) ) {
- if ( ! empty( $hook[0] ) ) {
- $link = '<a href="' .
- get_post_type_archive_link( 'wp-parser-hook' ) .
- str_replace( array( '‘', '’' ), '', $link ) .
- '">' . esc_html( $link ) . '</a>';
- }
- }
-
- // Link to function: {@link esc_attr()}
- else {
- $link = '<a href="' .
- get_post_type_archive_link( 'wp-parser-function' ) .
- str_replace( '()', '', $link ) .
- '">' . esc_html( $link ) . '</a>';
- }
-
- }
-
- return $link;
- },
- $content
- );
-}
</del></span></pre></div>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentthemespubwporgdeveloperincformattingphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: 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 (rev 0)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/formatting.php 2014-12-16 20:15:00 UTC (rev 1045)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,146 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+/**
+ * Code Reference formatting.
+ *
+ * @package wporg-developer
+ */
+
+/**
+ * Class to handle content formatting.
+ */
+class DevHub_Formatting {
+
+ /**
+ * Initializer
+ */
+ public static function init() {
+ add_action( 'init', array( __CLASS__, 'do_init' ) );
+ }
+
+ /**
+ * Handles adding/removing hooks to perform formatting as needed.
+ */
+ public static function do_init() {
+ add_filter( 'the_excerpt', array( __CLASS__, 'lowercase_P_dangit_just_once' ) );
+ add_filter( 'the_content', array( __CLASS__, 'make_doclink_clickable' ), 10, 5 );
+ }
+
+ /**
+ * Allows for "Wordpress" just for the excerpt value of the capital_P_dangit function.
+ *
+ * WP.org has a global output buffer that runs capital_P_dangit() over displayed
+ * content. For this one field of this one post, circumvent that function to
+ * to show the lowercase P.
+ *
+ * @param string $excerpt The post excerpt.
+ * @return string
+ */
+ public static function lowercase_P_dangit_just_once( $excerpt ) {
+ if ( 'wp-parser-function' == get_post_type() && 'capital_P_dangit' == get_the_title() ) {
+ $excerpt = str_replace( 'Wordpress', 'Wordpress', $excerpt );
+ }
+
+ return $excerpt;
+ }
+
+ /**
+ * Makes phpDoc @link references clickable.
+ *
+ * Handles these five different types of links:
+ *
+ * - {@link http://en.wikipedia.org/wiki/ISO_8601}
+ * - {@link WP_Rewrite::$index}
+ * - {@link WP_Query::query()}
+ * - {@link esc_attr()}
+ * - {@link http://codex.wordpress.org/The_Loop Use new WordPress Loop}
+ *
+ * @param string $content The content.
+ * @return string
+ */
+ public static function make_doclink_clickable( $content ) {
+
+ // Nothing to change unless a @link or @see reference is in the text.
+ if ( false === strpos( $content, '{@link ' ) && false === strpos( $content, '{@see ' ) ) {
+ return $content;
+ }
+
+ return preg_replace_callback(
+ '/\{@(?:link|see) ([^\}]+)\}/',
+ function ( $matches ) {
+
+ $link = $matches[1];
+
+ // Undo links made clickable during initial parsing
+ if ( 0 === strpos( $link, '<a ' ) ) {
+
+ if ( preg_match( '/^<a .*href=[\'\"]([^\'\"]+)[\'\"]>(.*)<\/a>(.*)$/', $link, $parts ) ) {
+ $link = $parts[1];
+ if ( $parts[3] ) {
+ $link .= ' ' . $parts[3];
+ }
+ }
+
+ }
+
+ // Link to an external resource.
+ if ( 0 === strpos( $link, 'http' ) ) {
+
+ $parts = explode( ' ', $link, 2 );
+
+ // Link without linked text: {@link http://en.wikipedia.org/wiki/ISO_8601}
+ if ( 1 === count( $parts ) ) {
+ $link = '<a href="' . esc_url( $link ) . '">' . esc_html( $link ) . '</a>';
+ }
+
+ // Link with linked text: {@link http://codex.wordpress.org/The_Loop Use new WordPress Loop}
+ else {
+ $link = '<a href="' . esc_url( $parts[0] ) . '">' . esc_html( $parts[1] ) . '</a>';
+ }
+
+ }
+
+ // Link to an internal resource.
+ else {
+
+ // Link to class variable: {@link WP_Rewrite::$index}
+ if ( false !== strpos( $link, '::$' ) ) {
+ // Nothing to link to currently.
+ }
+
+ // Link to class method: {@link WP_Query::query()}
+ elseif ( false !== strpos( $link, '::' ) ) {
+ $link = '<a href="' .
+ get_post_type_archive_link( 'wp-parser-class' ) .
+ str_replace( array( '::', '()' ), array( '/', '' ), $link ) .
+ '">' . esc_html( $link ) . '</a>';
+ }
+
+ // Link to hook: {@see 'pre_get_search_form'}
+ elseif ( 1 === preg_match( '/^(‘)\w+(’)$/', $link, $hook ) ) {
+ if ( ! empty( $hook[0] ) ) {
+ $link = '<a href="' .
+ get_post_type_archive_link( 'wp-parser-hook' ) .
+ str_replace( array( '‘', '’' ), '', $link ) .
+ '">' . esc_html( $link ) . '</a>';
+ }
+ }
+
+ // Link to function: {@link esc_attr()}
+ else {
+ $link = '<a href="' .
+ get_post_type_archive_link( 'wp-parser-function' ) .
+ str_replace( '()', '', $link ) .
+ '">' . esc_html( $link ) . '</a>';
+ }
+
+ }
+
+ return $link;
+ },
+ $content
+ );
+ }
+
+} // DevHub_Formatting
+
+DevHub_Formatting::init();
</ins><span class="cx" style="display: block; padding: 0 10px">Property changes on: sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/formatting.php
</span><span class="cx" style="display: block; padding: 0 10px">___________________________________________________________________
</span></span></pre></div>
<a id="svneolstyle"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: svn:eol-style</h4></div>
<ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+native
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of property
</span><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 2014-12-15 21:32:58 UTC (rev 1044)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/wporg-developer/inc/template-tags.php 2014-12-16 20:15:00 UTC (rev 1045)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -596,7 +596,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> $params[ $tag['variable'] ]['required'] = 'Required';
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> $params[ $tag['variable'] ]['content'] = htmlentities( $params[ $tag['variable'] ]['content'] );
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $params[ $tag['variable'] ]['content'] = make_doclink_clickable( $params[ $tag['variable'] ]['content'] );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $params[ $tag['variable'] ]['content'] = \DevHub_Formatting::make_doclink_clickable( $params[ $tag['variable'] ]['content'] );
</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></pre>
</div>
</div>
</body>
</html>