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


お勧め

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

5.3の新機能:日付とタイムゾーン(2019年10月2日 更新)

WordPress 5.3 Beta 1」に記載されていた「Time/Date component fixes」という見出し。開発者向として新しい関数の追加や多くのバグが修正されたとなっており、チェックせざるを得ない。

ショートコードを含んだページを表示する前に何か処理する(2014年5月28日 更新)

固定ページまたは投稿ページに独自のフォームを埋め込む。入力→登録の2段階のフォームなら著名なプラグイン「Contact Form 7」を利用すればいいのだが、クライアントの依頼は入力→確認→登録の3段階で組み込む要素が特化していたので、独自の実装方法を考えることになった。

Emojin:プラグイン作ってみました(2015年3月21日 更新)

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。