<!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>[30396] trunk/src: Introduce two new filters to the post revisions screen:</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="https://core.trac.wordpress.org/changeset/30396">30396</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/30396","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>johnbillion</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2014-11-19 23:20:07 +0000 (Wed, 19 Nov 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'>Introduce two new filters to the post revisions screen:
* `process_text_diff_html` for contextually filtering a diffed line. Allows for the line to be processed in a different manner to the default `htmlspecialchars`.
* `revision_text_diff_options` for filtering the options passed to `wp_text_diff()` when viewing a post revision.
Fixes <a href="https://core.trac.wordpress.org/ticket/24908">#24908</a>
Props adamsilverstein</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcwpadminincludesrevisionphp">trunk/src/wp-admin/includes/revision.php</a></li>
<li><a href="#trunksrcwpincludeswpdiffphp">trunk/src/wp-includes/wp-diff.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcwpadminincludesrevisionphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-admin/includes/revision.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-admin/includes/revision.php 2014-11-19 22:45:43 UTC (rev 30395)
+++ trunk/src/wp-admin/includes/revision.php 2014-11-19 23:20:07 UTC (rev 30396)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -73,7 +73,28 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /** This filter is documented in wp-admin/includes/revision.php */
</span><span class="cx" style="display: block; padding: 0 10px"> $content_to = apply_filters( "_wp_post_revision_field_$field", $compare_to->$field, $field, $compare_to, 'to' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $diff = wp_text_diff( $content_from, $content_to, array( 'show_split_view' => true ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $args = array(
+ 'show_split_view' => false
+ );
+ /**
+ * Filter revisions text diff options.
+ *
+ * Filter the options passed to `wp_text_diff()` when viewing a post revision.
+ *
+ * @since 4.1.0
+ *
+ * @param array $args {
+ * Associative array of options to pass to `wp_text_diff()`.
+ *
+ * @type bool $show_split_view False for split view (two columns), true for
+ * un-split view (single column). Default false.
+ * }
+ * @param string $field The current revision field.
+ * @param WP_Post $compare_from The revision post to compare from.
+ * @param WP_Post $compare_to The revision post to compare to.
+ */
+ $args = apply_filters( 'revision_text_diff_options', $args, $field, $compare_from, $compare_to );
+ $diff = wp_text_diff( $content_from, $content_to, $args );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! $diff && 'post_title' === $field ) {
</span><span class="cx" style="display: block; padding: 0 10px"> // It's a better user experience to still show the Title, even if it didn't change.
</span></span></pre></div>
<a id="trunksrcwpincludeswpdiffphp"></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/wp-diff.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/wp-diff.php 2014-11-19 22:45:43 UTC (rev 30395)
+++ trunk/src/wp-includes/wp-diff.php 2014-11-19 23:20:07 UTC (rev 30396)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -153,8 +153,25 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function _added( $lines, $encode = true ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $r = '';
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ($lines as $line) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $encode )
- $line = htmlspecialchars( $line );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $encode ) {
+ $processed_line = htmlspecialchars( $line );
+
+ /**
+ * Contextually filter a diffed line.
+ *
+ * Filters TextDiff processing of diffed line. By default, diffs are processed with
+ * htmlspecialchars. Use this filter to remove or change the processing. Passes a context
+ * indicating if the line is added, deleted or unchanged.
+ *
+ * @since 4.1.0
+ *
+ * @param String $processed_line The processed diffed line.
+ * @param String $line The unprocessed diffed line.
+ * @param string null The line context. Values are 'added', 'deleted' or 'unchanged'.
+ */
+ $line = apply_filters( 'process_text_diff_html', $processed_line, $line, 'added' );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $this->_show_split_view ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $r .= '<tr>' . $this->emptyLine() . $this->emptyLine() . $this->addedLine( $line ) . "</tr>\n";
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -175,8 +192,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function _deleted( $lines, $encode = true ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $r = '';
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ($lines as $line) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $encode )
- $line = htmlspecialchars( $line );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $encode ) {
+ $processed_line = htmlspecialchars( $line );
+ /** This filter is documented in wp-includes/wp-diff.php */
+ $line = apply_filters( 'process_text_diff_html', $processed_line, $line, 'deleted' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $this->_show_split_view ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $r .= '<tr>' . $this->deletedLine( $line ) . $this->emptyLine() . $this->emptyLine() . "</tr>\n";
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -198,8 +218,11 @@
</span><span class="cx" style="display: block; padding: 0 10px"> public function _context( $lines, $encode = true ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $r = '';
</span><span class="cx" style="display: block; padding: 0 10px"> foreach ($lines as $line) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( $encode )
- $line = htmlspecialchars( $line );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( $encode ) {
+ $processed_line = htmlspecialchars( $line );
+ /** This filter is documented in wp-includes/wp-diff.php */
+ $line = apply_filters( 'process_text_diff_html', $processed_line, $line, 'unchanged' );
+ }
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( $this->_show_split_view ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $r .= '<tr>' . $this->contextLine( $line ) . $this->emptyLine() . $this->contextLine( $line ) . "</tr>\n";
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span></span></pre>
</div>
</div>
</body>
</html>