【WordPress】エディタにCSSを読み込む方法の最適解はどれ

【WordPress】エディタにCSSを読み込む方法の最適解はどれ

子テーマやプラグインから、エディター画面にCSSを読み込ませる方法がいくつかありましたので、最適解を探っていこうと思います。

今回は、以下の2通りご紹介します。

  • 方法1:add_editor_style()で読み込む
  • 方法2:enqueue_block_editor_assetsで読み込む
目次

環境

2つのスタイルシートを用意

まず「フロント用」と「エディター用」のCSSファイルを用意します。

  • フロント用→サイトに適用させるスタイル
  • エディター用→編集画面に適用させるスタイル

プラグインから読み込んでみる

今回は例として、自作プラグインからCSSを読み込んでみます。

  • my-plugin
    • my-plugin.php(ここから読み込む)
    • css
      • style.css(フロント用)
      • editor-style.css(エディター用)

編集画面は実際のサイトにできるだけ近づけるのが望ましいため、通常はフロント用CSSをエディターにも読み込みます。

そうすることで、エディター用CSSは微調整(エディター特有の余白・枠線など)だけで済むようになります。

方法1:add_editor_style()で読み込む

/**
 * エディター用の CSS 読み込み
 */
add_action( 'after_setup_theme', function() {

  // ブロックエディターをサポート(ブロックテーマでは記述不要)
  add_theme_support( 'editor-styles' );

  // 指定のファイルを読み込む
  add_editor_style( plugin_dir_url( __FILE__ ) . 'css/style.css' ); // フロント用
  add_editor_style( plugin_dir_url( __FILE__ ) . 'css/editor-style.css' ); // エディター専用
});

add_editor_style()はエディターにスタイルを読み込むメジャーな方法です。

本来はテーマ用に作られた関数ですが、プラグインからでも使用可能です。

add_theme_support( 'editor-styles' )の記述がない場合は、クラシックエディターでのみスタイルが読み込まれます。

ただし、ブロックテーマにおいてはデフォルトでサポートされているため記述は不要です。

特徴

  • 自動で.editor-styles-wrapperが追加される
  • クラシックエディターとブロックエディター両方で読み込まれる
  • インラインCSSとして出力される(ブラウザキャッシュ対策は不要)
  • 依存関係は指定できない

自動で.editor-styles-wrapperが追加される

ブロックエディターの編集エリアは.editor-styles-wrapperというクラスで囲まれており、本来スタイルを当てる際にはこのクラスを意識して記述する必要があります。

しかし、add_editor_style()では、エディタースタイル内のbody要素は.editor-styles-wrapperに書き換えられ、各セレクタの接頭辞にもクラスが追加されて出力されます。

記述したCSS

body {
  background-color: #fff;
}

p {
  color: #333;
}

出力されるCSS

.editor-styles-wrapper {
  background-color: #fff;
}

.editor-styles-wrapper p {
  color: #333;
}

この仕組みのおかげで、特別な対応をせずともエディター専用のスタイルを容易に反映させることができるというわけです。

テーマとプラグインでのパス指定

テーマディレクトリからであれば相対パスで指定できますが、プラグインから読み込む場合はプラグインのURLを指定すると正しく動作します。

// テーマに記述する場合
add_editor_style( 'css/editor-style.css' );

// プラグインに記述する場合
add_editor_style( plugin_dir_url( __FILE__ ) . 'css/editor-style.css' );

詳細度によって問題がおこるケース

以下の記述すると、スタイルの読み込み順が変わり、テーマ内の詳細度の低いスタイルが上書きされてしまうケースがあります。

add_action( 'after_setup_theme', function() {
  add_theme_support( 'editor-styles' );
});

検証したテーマ(SWELL)では、独自ボタンの色変更が、エディター上で反映されなくなりました。

通常時

[class*=is-style-btn_] {
  /* ①デフォルト */
}
.red_ {
  /* ②色指定(テーマ) */
}

editor-styles有効時

.red_ {
  /* ①色指定(テーマ) */
}
:where(.editor-styles-wrapper) [class*=is-style-btn_] {
  /* ②デフォルトが上書き */
}

このように、テーマ設計の段階では問題なくても、プラグインなど後からスタイルを適用する場合は、意図しない挙動になることがあります。

フロントでは問題ないですが、念のため仕様を理解しておいたほうが吉です。

方法2:enqueue_block_editor_assetsで読み込む

/**
 * ブロックエディター用のCSS読み込み
 */
function enqueue_custom_editor_assets() {

    // フロント用
    wp_enqueue_style(
        'my-custom-plugin-style',
        plugin_dir_url( __FILE__ ) . 'css/style.css',
        [],
        filemtime( plugin_dir_path( __FILE__ ) . 'css/style.css' )
    );

    // エディター用
    wp_enqueue_style(
        'my-custom-plugin-editor-style',
        plugin_dir_url( __FILE__ ) . 'css/editor-style.css',
        [],
        filemtime( plugin_dir_path( __FILE__ ) . 'css/editor-style.css' )
    );
}
add_action( 'enqueue_block_editor_assets', 'enqueue_custom_editor_assets' );

スタイルシートを読み込むには、wp_enqueue_style()を使って追加します。

特徴

  • 編集画面全体(サイドバーやツールバーなど)にスタイルが影響する
  • ブロックエディターでのみ読み込まれる
  • 外部CSSファイルとして読み込まれる
  • 依存関係を指定できる

CSSの書き方に注意

ブロック(iframe内)に反映するには、CSSファイル内に.editor-styles-wrapperか.wp-block(.wp-block-* )を含むセレクタが1つ以上必要です。

以下のように、.editor-styles-wrapperでラップしていない場合、サイドバーやツールバーなどにも影響される点に注意が必要です。

/* フロント用CSS */
button {
  font-size: 20px!important;
}

おまけ:enqueue_block_assetsフック

enqueue_block_assetsはフロントとエディター(iframe内・外)の両方で読み込まれるフックです。

is_admin()で判定し、エディターのみ、もしくはフロントのみで読み込むといったことも柔軟に対応できます。

/**
 * コンテンツアセットのエンキュー。ただし、エディター内のみ
 */
function example_enqueue_editor_content_assets() {
    if ( is_admin() ) {
        wp_enqueue_script(
            'example-editor-content-scripts',
            plugins_url( 'constent-scripts.css', __FILE__ )
        );
        wp_enqueue_style(
            'example-editor-content-styles',
            plugins_url( 'constent-styles.css', __FILE__ )
        );
    }
}
add_action( 'enqueue_block_assets', 'example_enqueue_editor_content_assets' );

ただし、こちらもUI全体に影響してしまうため、エディタ内(ブロック)だけに効かせたいルールには .editor-styles-wrapper を付けてスコープを絞る必要があります。

どちらが良いか:add_editor_style()がおすすめ

両者の大きな違いは、.editor-styles-wrapperが自動で追加されるかとどうか、依存関係の指定の有無です。

add_editor_style()の場合は、ブロックエディターを囲っている.editor-styles-wrapperの直前でインラインCSSとして優先的に読み込んでいるため、依存関係は特に不要だと思っています。

やはり、自動でエディター専用クラスが追加されるのはメリットとして非常に大きいので、他に理由がない限りadd_editor_style()で読み込む方が良いかもしれません。

カスタマイズに困ったらお気軽にご相談を!

  • 「ちょっとしたCSSの調整だけお願いしたい」
  • 「不具合を直してほしい」

料金は3,000円〜、お支払いは銀行振込・Amazonギフトカードなど柔軟に対応してます🤔

役に立ったら他の方にシェア

お気軽にコメントどうぞ

コメントする

目次