Changeset 30396

Timestamp:

11/19/2014 11:20:07 PM (10 years ago)

Author:

johnbillion

Message:

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 #24908
Props adamsilverstein

Location:

trunk/src

Files:

• wp-admin/includes/revision.php (modified) (1 diff)
• wp-includes/wp-diff.php (modified) (3 diffs)

trunk/src/wp-admin/includes/revision.php

@@ -74 +74 @@
         $content_to = apply_filters( "_wp_post_revision_field_$field", $compare_to->$field, $field, $compare_to, 'to' );
 
-        $diff = wp_text_diff( $content_from, $content_to, array( 'show_split_view' => true ) );
+        $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 );
 
         if ( ! $diff && 'post_title' === $field ) {

trunk/src/wp-includes/wp-diff.php

@@ -154 +154 @@
         $r = '';
         foreach ($lines as $line) {
-            if ( $encode )
-                $line = htmlspecialchars( $line );
+            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' );
+            }
+
             if ( $this->_show_split_view ) {
                 $r .= '<tr>' . $this->emptyLine() . $this->emptyLine() . $this->addedLine( $line ) . "</tr>\n";
@@ -176 +193 @@
         $r = '';
         foreach ($lines as $line) {
-            if ( $encode )
-                $line = htmlspecialchars( $line );
+            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' );
+            }
             if ( $this->_show_split_view ) {
                 $r .= '<tr>' . $this->deletedLine( $line ) . $this->emptyLine() . $this->emptyLine() . "</tr>\n";
@@ -199 +219 @@
         $r = '';
         foreach ($lines as $line) {
-            if ( $encode )
-                $line = htmlspecialchars( $line );
+            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' );
+            }
             if (  $this->_show_split_view ) {
                 $r .= '<tr>' . $this->contextLine( $line ) . $this->emptyLine() . $this->contextLine( $line )  . "</tr>\n";