Changeset 45778 for trunk/src/wp-includes/pluggable.php

Timestamp:

08/10/2019 10:27:02 PM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Document the show_split_view argument for wp_text_diff().

Convert $args array documentation to hash notation.

Props riddhiehta02, jeremyfelt, SergeyBiryukov.
Fixes #47224.

File:

• trunk/src/wp-includes/pluggable.php (modified) (2 diffs)

trunk/src/wp-includes/pluggable.php

@@ -2670 +2670 @@
      * are equivalent, then an empty string will be returned.
      *
-     * The arguments supported and can be changed are listed below.
-     *
-     * 'title' : Default is an empty string. Titles the diff in a manner compatible
-     *      with the output.
-     * 'title_left' : Default is an empty string. Change the HTML to the left of the
-     *      title.
-     * 'title_right' : Default is an empty string. Change the HTML to the right of
-     *      the title.
-     *
      * @since 2.6.0
      *
@@ -2687 +2678 @@
      * @param string       $left_string  "old" (left) version of string
      * @param string       $right_string "new" (right) version of string
-     * @param string|array $args         Optional. Change 'title', 'title_left', and 'title_right' defaults.
+     * @param string|array $args {
+     *     Associative array of options to pass to WP_Text_Diff_Renderer_Table().
+     *
+     *     @type string $title           Titles the diff in a manner compatible
+     *                                   with the output. Default empty.
+     *     @type string $title_left      Change the HTML to the left of the title.
+     *                                   Default empty.
+     *     @type string $title_right     Change the HTML to the right of the title.
+     *                                   Default empty.
+     *     @type bool   $show_split_view True for split view (two columns), false for
+     *                                   un-split view (single column). Default true.
+     * }
      * @return string Empty string if strings are equivalent or HTML with differences.
      */
     function wp_text_diff( $left_string, $right_string, $args = null ) {
         $defaults = array(
-            'title'       => '',
-            'title_left'  => '',
-            'title_right' => '',
+            'title'           => '',
+            'title_left'      => '',
+            'title_right'     => '',
+            'show_split_view' => true,
         );
         $args     = wp_parse_args( $args, $defaults );