From 6ca6c447b9d3630256782668d5016c59ff4a5b43 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Sat, 10 Aug 2019 22:27:02 +0000 Subject: [PATCH] Docs: Document the `show_split_view` argument for `wp_text_diff()`. Convert `$args` array documentation to hash notation. Props riddhiehta02, jeremyfelt, SergeyBiryukov. Fixes #47224. git-svn-id: https://develop.svn.wordpress.org/trunk@45778 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/pluggable.php | 29 ++++++++++++++++------------- 1 file changed, 16 insertions(+), 13 deletions(-) diff --git a/src/wp-includes/pluggable.php b/src/wp-includes/pluggable.php index 4edb9929f6..ee6c525159 100644 --- a/src/wp-includes/pluggable.php +++ b/src/wp-includes/pluggable.php @@ -2669,15 +2669,6 @@ if ( ! function_exists( 'wp_text_diff' ) ) : * HTML, so the primary use is for displaying the changes. If the two strings * 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 * * @see wp_parse_args() Used to change defaults to user defined settings. @@ -2686,14 +2677,26 @@ if ( ! function_exists( 'wp_text_diff' ) ) : * * @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 );