標準で組み込まれた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



お勧め

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

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

WP_List_Tableクラスを使ってみた(2018年5月27日 更新)

WordPressの管理画面ではデータを一覧表示しているページがいくつもある。今回この仕組みを自分のプラグインでも使ってみたいと思い、調査しながらプラグインに組み込んでみた。

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

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

常時SSL接続に変更しました(2018年5月27日 更新)

先週末、本サイトを常時SSL接続に変更しました。本サイトは「さくらのVPS」(CentOS 6系、Apache 2.2系)上にWordPressのマルチサイト機能を使って構築しており、無償で使用できる「Let's Encrypt」を使って常時SSL接続に切り替えた手順をメモとして残しそうと思います。

テキストエディタの文字を変更する(2018年5月27日 更新)

テキストエディタ(投稿ページの「テキスト」タブのエディタ)に標準では備わっていない機能を追加する自作プラグイン「html entities button」がほぼ1年ぶりにアップデート。ここではバージョン2.0.0で追加したテキストエディタのフォント切り替え機能について紹介する。