標準で組み込まれたclipboard.jsを使ってみた

説明

5.2の新機能「サイトヘルス情報」では、現状のサイト情報をクリップボードにコピーする機能がある。この機能の実装方法を調べてみると、clipboard.jsが利用されていた。

サイト情報のコピー機能

まずは「サイトヘルス情報」ページを開いて、サイト情報のコピー機能がどのように実装されているのか調べていく。この機能としては「サイト情報をクリップボードにコピー」ボタンがクリックされると、サイト情報がクリップボードにコピーせれる仕組みである。

サイト情報をクリップボードにコピーしたところ

このボタン部分をブラウザの開発者向け機能で確認すると、data-clipboard-text属性にサイト情報が丸ごと入っていることがわかる。

<button type="button" class="button copy-button" data-clipboard-text="`
### wp-core ###

version: 5.2
site_language: ja
user_language: ja

(省略)

`">
<span class="success" aria-hidden="true">コピーしました。</span>

これに対し、/wp-admin/js/site-health.jsを覗いてJavaScript側がどのようになっているかを確認。次は関連する部分を抜粋したものとなる。

var clipboard = new ClipboardJS( '.site-health-copy-buttons .copy-button' );

clipboard.on( 'success', function( e ) {
	var $wrapper = $( e.trigger ).closest( 'div' );
	$( '.success', $wrapper ).addClass( 'visible' );

	wp.a11y.speak( __( 'Site information has been added to your clipboard.' ) );
} );

ClipboardJSクラスのインスタンスを生成し、'success'イベントでspan要素に対して操作している。肝となるクリップボードに対してテキストをコピーする部分はまったく見えない仕様のようだ。続いて、ClipboardJSクラスが定義されているファイルを調べると、/wp-includes/js/clipboard.jsが見つかった。

このclipboard.jsは、/wp-includes/script-loader.phpにて次のように登録されている。

$scripts->add( 'clipboard', "/wp-includes/js/clipboard$suffix.js", array(), false, 1 );

(省略)

$scripts->add( 'site-health', "/wp-admin/js/site-health$suffix.js", array( 'clipboard', 'jquery', 'wp-util', 'wp-a11y', 'wp-i18n' ), false, 1 );

clipboard.jsのハンドル名は'clipboard'として、site-health.jsはこの'clipboard'に依存する指定でハンドル名'site-health'として登録されている。

実際に使ってみた

実際にプラグインで使う場合はまず wp_enqueue_script関数を使用する。

if ( wp_script_is( 'clipboard', 'registered' ) ) {
	wp_enqueue_script( 'clipboard' );
}

HTML側はクリップボードにコピーする内容が決まっている場合は次のような感じになる。クリック対象の要素は、サイトヘルス機能のようにbutton要素でもよいが、その他の要素でも問題はなく、ここではspan要素を使っている。

<span class="dashicons dashicons-clipboard" data-clipboard-text="コピーする内容をここに!"></span>

クリップボードにコピーした際に表示を変更するようなことをしないのであればコードは1行でよい。

const clipboard = new ClipboardJS( '.dashicons-clipboard' );

応用例

HTMLを出力する際にコピーする内容が決まっていない場合は、data-clipboard-text属性ではなく、data-clipboard-target属性を使用すればよい。

<textarea id="memo"></textarea>

<span class="dashicons dashicons-clipboard" data-clipboard-target="#memo"></span>

この例であれば、クリック時にtextarea#memoの入力内容がクリップボードにコピーすることができる。

以上のように、clipboard.js(ClipboardJSクラス)はシンプルなコーディングでクリップボードのコピー機能を実装できる。Zeno Rochaさん、ありがとう。


最終更新 : 2019年05月15日 12:59



お勧め

5.7の新機能:AJAXでパスワードを取得(2021年2月17日 更新)

日本時間の今朝「WordPress 5.7 Beta 3(以降Beta 3)」が予定通り公開されました。今回は、ソースコードを眺めていた時に気になったパスワードを取得できるAJAXについて確認した。

5.4.1でパーマリンクの仕様が一部変更された件(2020年5月12日 更新)

先月末にリリースされたバージョン5.4.1のアップデートにより、一部のサイトで投稿ページが従来通りに表示されなくなる不具合が発生し、サポートサイトにレポートが上がりました。この件について、ちょっとモヤモヤしたので自分なりに考えてみました。

使っていないか確認しないとね!(2022年6月7日 更新)

2003年に誕生したWordPress。その歴史の中には、廃止予定(deprecated)となっている関数がいくつも存在する。それらの関数をテーマやプラグインで使用するべきではないし、使用しているなら代替の関数に書き換えるべきである。ここでは3.25.9.0現在、廃止予定となっている関数をまとめて紹介する。

HTML編集モードに定型文ボタンを追加する(2011年6月1日 更新)

投稿編集ページにはビジュアル編集モードとHTML編集モードがあり、それらを拡張するプラグインも多数存在している。そういったプラグインを利用するのもいいのだが、仕組みを理解するのも悪くないはず。というわけで、ここではHTML編集モードのボタンの仕組みと定型文を挿入するボタンを追加する方法を紹介する。

テーブルの1列目をth要素にしてみる(2021年12月21日 更新)

標準の「テーブル」ブロックでは、tbody要素内のセルはすべてtd要素になっている。テーブルの1列目についてはth要素を使いたいケースがあり、「トグル」コントロールを使って切り替え可能にできないか調べてみた。