標準で組み込まれた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.5で非推奨になる関数名について(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。

meta_compare_key使ってみた(2019年3月19日 更新)

ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。

プラグインの設定ページもレスポンシブ対応(2014年6月3日 更新)

レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。

初期化に関連するアクションのおさらい(2013年11月27日 更新)

いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。

全投稿を取得するのはnopaging=1でいい(2011年8月31日 更新)

query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?