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


お勧め

WordPressと組み込まれている主なJavaScriptライブラリのバージョン一覧(2018年5月27日 更新)

WordPressの更新が遅れていたサイトを少し前に更新したところ、jQuery UI sortableを使って拡張したページに不具合が発生しました。WordPressの更新に伴って内部のjQuery UIが更新されたことに起因すると思われ、これを機にWordPressとそれに組み込まれたJavaScriptライブラリのバージョンを確認してみました。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

検索ワード「-10,000円」を検索できるようにしたい(2018年5月27日 更新)

とあるサイトで「-10,000円」をキーワードに検索した際、予想と異なるページが表示され、ちょっと驚いた。今回はその原因調査と対策についてまとめてみた。

ダッシュボードのフィードボックスをカスタマイズ(2011年7月8日 更新)

管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する(管理者権限)。