wp_text_diff

説明

string wp_text_diff( string $left_string, string $right_string [ , mixed $args = null ] )
2つの文字列を比較する。

パラメータ

  • $left_string
    古い方の文字列を指定。
  • $right_string
    新しい方の文字列を指定。
  • $args
    取得条件を連想配列または文字列で指定(省略時はnull)。主なキーは次の通り。
    キー内容省略時の値
    'show_split_view'比較結果を左右で表示する場合はtrueを指定true
    'title'表全体のタイトルを指定''
    'title_left'$left_stringのタイトルを指定''
    'title_right'$right_stringのタイトルを指定''

返り値

文字列の違いを示すHTML(table要素)を返す。違いがない場合は空の文字列を返す。


注意

比較は行単位で行われ、左右比較モード('show_split_view'がtrue)では、以下のような内容になる。

違い左側右側
古い方のみにあるtd要素はdiff-deletedlineクラス
新しい方のみにあるtd要素はdiff-addedlineクラス
内容が異なるtd要素はdiff-deletedlineクラスtd要素はdiff-addedlineクラス

単一モード('show_split_view'がfalse)では、以下のような内容になる。

違い左側
古い方のみにあるtd要素はdiff-deletedlineクラス
新しい方のみにあるtd要素はdiff-addedlineクラス
内容が異なる1行目のtd要素はdiff-deletedlineクラス、2行目のtd要素はdiff-addedlineクラス

なおパラメータ$argsに'title'、'title_left'、'title_right'のいずれかを指定するとthead要素内が4カラムになり、tbody要素内とカラム数が異なってしまい、意図した表示にならない(バージョン4.9.8で確認)。タイトルを付けたい場合は本関数を使用せず、本関数を参考にして独自に実装する方がいいだろう。


使用例

  • 投稿とリビジョンの本文部分を比較し、結果を左右比較モードで表示する。
    <?php echo wp_text_diff( $revisions[0]->post_content, $post->post_content ); ?>
  • 投稿とリビジョンの本文部分を比較し、結果を単一モードで表示する。
    <?php echo wp_text_diff( $revisions[0]->post_content, $post->post_content, array( 'show_split_view' => false ) ); ?>

フィルター

実行するフィルターはありません。

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/pluggable.php

最終更新 : 2018年08月27日 12:56


お勧め

カレンダーウィジェットをAjaxで切り替える(2011年8月22日 更新)

ウィジェットベースでテーマを構築していてカレンダーを表示してみた。標準では、前月や次月のリンク先はそれぞれの月のアーカイブページとなっているのだが、記事を探すだけであればカレンダー部分だけを更新するほうが便利なのではと考え、そのアイデアを実装してみた。

3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2014年1月17日 更新)

ちょうど1月前の「ダッシュボードの「概要」にカスタム投稿タイプ件数を表示する」にて、WordPress 3.8新ダッシュボードの「概要」ウィジェットにカスタム投稿タイプの投稿数を表示する方法を紹介したが、今回のその続編で「アクティビティ」ウィジェットを拡張する方法を紹介する。

5.5の機能強化:コメントフォームのちょっとした改良(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2、3と公開が続いている。「WordPress 5.5 Beta 3(以降Beta 3)」のソースコードを見ていくと、コメントフォームを表示する comment_form関数が機能拡張されていた。

5.3への準備:投稿写真を使っているサイトは準備しておこう(2019年10月10日 更新)

この記事は先日公開した「5.3の新機能:JPEG画像の向きを調整」の続きのようなものになる。高解像度の投稿写真を扱っているサイトは、5.3のリリースに合わせて対応を検討しておくべきことをまとめてみた。

画像ブロックに効果を追加した時にハマった(2023年3月30日 更新)

画像ブロックに対して見た目が変わる効果を追加しようと思い機能拡張してみた。その際、いくつかの効果は問題なかったのだが、1つの効果だけその画像を選択したときのみ効果が消える不具合が発生。対処内容はシンプルなものだが、忘れないようにメモっとく。