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


お勧め

管理画面でツールバー(Admin bar)を非表示にする(2013年3月5日 更新)

WordPress使ってちょっと変わったサイトを構築する際、管理画面のツールバーを表示させたくないケースがある。一般に公開するサイト側であれば、 show_admin_bar関数で非表示にできるのだが、管理画面ではこれを使ってもツールバーは消えてくれない。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

タイトルが一致する投稿を検索する(2014年2月20日 更新)

WordPressが提供する投稿ページの文字列検索機能の実現には、 query_posts関数(WP_Queryクラス)が大きな役割を担っている。ここで紹介するのは、高機能ゆえに使いこなすのが難しいquery_posts関数(WP_Queryクラス)の使用法の一例である。

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

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

WordPressの鼓動(2013年10月1日 更新)

WordPressでは、Ajaxを利用する方法の1つとして add_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。