ETBS Edit Conflict Guard

説明

WordPress は、他の人が投稿を編集していることを標準で知らせてくれます。投稿タイトルの下に出る「編集中です」の通知です。しかしこの通知は警告にすぎません。2人目の編集者が「更新」や「公開」をクリックするのを止めることはなく、保存も止まりません。2人が同じ投稿をほぼ同時に編集すると、最後に保存した人が相手の変更を黙って上書きしてしまい、WordPress 本体にはそれを防ぐ仕組みがありません。

ETBS Edit Conflict Guard は、この通知に加えて投稿単位の実効性のある排他ロックを追加します。あるユーザーが投稿を開いて編集している間、他のすべてのユーザーの保存をブロックし、その理由をはっきりと伝えます。

動作の仕組み

• 投稿の編集画面を開くと、その投稿のロックの取得を試みます (先に開いた人がロックを取得します)。
• 編集画面を開いている間、ロックは WordPress 標準の Heartbeat API によって自動的に延長されます。
• 「下書き保存」「更新」「公開」をクリックすると (旧エディター・ブロックエディターのどちらでも) ロックを判定します。他の人がロックを取得している場合、保存はブロックされ、モーダルで理由を説明します。
• ロックは、保存に成功したとき、または Heartbeat が止まり (タブを閉じた場合など) 有効期限が過ぎたときに、自動的に解除されます。
• ブロックは、旧エディターの投稿保存とブロックエディターの REST 経由の保存の両方について、サーバー側でも実施されます。そのため JavaScript が無効な場合や通信が不安定な場合でも、ロックは有効なままです。

管理画面を持つ投稿タイプは、初期状態ですべて対象になります (添付ファイルは除外)。設定画面から個別に除外できます。ロックの判定は「下書き保存」「更新」「公開」をクリックした瞬間にのみ行われ、編集画面を開いただけの状態では何も表示されません。

設定

設定 > Edit Conflict Guard で次の項目を変更できます。

• ロックの有効期限 (秒)。
• ロックの対象から除外する投稿タイプ。
• ロック中の投稿のゴミ箱への移動もブロックするかどうか (初期状態はオフ。オンにすると、ロックを取得している本人の別タブからでも、ロック中の投稿のゴミ箱への移動はすべてブロックされます。完全削除は対象外です)。
• 現在ロック中のすべての投稿を表示する一覧表。管理者向けに、行ごとの「強制解除」ボタンが付きます。

既知の制限

Edit Conflict Guard は意図的に厳格な作りになっており、その結果として、あらかじめ知っておいたほうがよい癖がいくつかあります。

1. ブロックエディターのゴミ箱通知。 「ゴミ箱へ移動」がブロックされると、サーバーは正しく拒否します (投稿は公開状態のまま) が、ブロックエディター自体は「ゴミ箱へ移動しました」という成功通知を一瞬表示することがあります。これはロックの失敗ではなく、WordPress 本体の表示先行の挙動です。投稿一覧を再読み込みすれば、実際には移動していないことを確認できます。
2. 一括でのゴミ箱移動。 ゴミ箱ブロックが有効なとき、投稿一覧からの一括「ゴミ箱へ移動」の対象にロック中の投稿が含まれていると、その投稿で処理が止まり、後続の投稿は未処理のまま残ります。
3. 完全削除はゴミ箱ブロックの対象外です。 ゴミ箱ブロックが対象にするのはゴミ箱への移動だけです。ゴミ箱を経由せずに完全削除する操作 (たとえばカスタム投稿タイプに対する XML-RPC の wp.deletePost は、WordPress 本体がゴミ箱に入れず直接削除します) は、投稿がロック中でもブロックされません。
4. マルチサイトには対応していません。 ロックはマルチサイトのネットワーク内の他のサイトを認識せず、サイト間で共有されることもありません。
5. ロックは取得した本人にも適用されます。 仕様として、ロックを取得しているユーザー自身も、2つ目のタブやウィンドウから同じ投稿を保存することはできません。これは不具合ではなく意図的な動作です。プラグインには、2つのタブと2人の別々の編集者を区別する手段がありません。