説明
パラメータ
- $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
お勧め
meta_compare_key使ってみた(2019年3月19日 更新)
ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。
WP_List_Tableクラスの「一括操作」フォームを使ってみた(2018年5月27日 更新)
今回は「WP_List_Tableクラスを使ってみた」の続き。投稿一覧やプラグインページなどにある「一括操作」(Bulkアクション)フォーム対応に関するメモである。
テーマから投稿画像のサイズを指定する(2012年3月15日 更新)
投稿記事に挿入する画像サイズは、サムネイル(150×150)、中サイズ(300×300)、大サイズ(1024×1024)がデフォルトだが、テーマによっては別のサイズを指定したい場合はある。基本的には、「設定」-「メディア」の「メディア設定」ページで指定できるが、テーマ内のfunctions.phpで設定しておくとちょっと便利かもしれない。ログインページを変える(2014年9月12日 更新)
WordPressの標準的な不正ログイン対策としては、ログインIDは'admin'を避けるパスワードはユニークで長くする、場合によってはアクセスできるIPアドレスを制限する、といった具合だろう。これらの他に何かできないものだろうかと、ちょっと考えてみた。新規投稿時の本文プレースホルダーテキストを変える(2021年9月9日 更新)
ブロックエディターに影響を与えるフィルターは多数存在する。今回紹介するフィルターはその1つで、新規投稿時の本文ブロックのプレースホルダーテキストを変更するものだ。