Xwriteの「ふき出し」にデフォルトのプリセットを設定するカスタマイズ

未分類
この記事は約17分で読めます。
記事内に広告が含まれています。

Xwrite 4.0.7

はじめに

Xwriteで、以下を実現します。

Xwriteのブロックエディターには「ふき出し」ブロックが用意されており、あらかじめ登録したプリセットを呼び出すことで、アイコンや配置などをまとめて設定できます。

しかし、新しく「ふき出し」ブロックを挿入したときは、左寄せ・アイコンなしの初期状態で追加されます。そのため、毎回プリセットを呼び出して設定を変更する必要があります。

そこで今回は、任意のプリセットをデフォルトに設定し、新しく挿入した「ふき出し」ブロックに自動適用する機能を追加します。

この記事では、この方法について説明します。

実装イメージ

実装手順

以下のコードをfunctions.phpに追加します。

add_action('enqueue_block_editor_assets', function () {
  ob_start();
  ?>
  (function (wp) {
    // 対象ブロックとプリセット・標準設定の保存先を設定
    var BLOCK = "xwrite/fukidashi";
    var PRESET_SCOPE = "xwrite/block_preset";
    var DEFAULT_SCOPE = "xwc/block_preset_default";

    // 処理済みのブロック名とブロックIDを管理
    var ensured = new Set();
    var handled = new Set();

    // 必要なWordPressのAPIが利用できない場合は処理対象外
    if (!wp || !wp.hooks || !wp.compose || !wp.element || !wp.data ||
      !wp.blocks || !wp.components || !wp.blockEditor) {
      return;
    }

    // 要素生成関数を取得
    var el = wp.element.createElement;

    // 標準プリセットの初期値を登録
    wp.data.dispatch("core/preferences").setDefaults(DEFAULT_SCOPE, {
      defaults: {}
    });

    /**
     * エディターの読み込み状態を取得
     *
     * 読み込み前のブロックは既存記事の内容として扱い、
     * 標準プリセットの自動適用対象から除外
     *
     * @returns {boolean} 読み込み完了ならtrue
     */
    function isEditorReady() {
      var editor = wp.data.select("core/editor");

      // 判定用APIが利用できない場合は読み込み完了として扱う
      return editor && typeof editor.__unstableIsEditorReady === "function"
        ? editor.__unstableIsEditorReady()
        : true;
    }

    /**
     * 保存済みのふき出しプリセット一覧を取得
     *
     * @returns {Object} プリセット名をキーとするオブジェクト
     */
    function getPresets() {
      var all = wp.data.select("core/preferences").get(PRESET_SCOPE, "blockPresets");

      return all && all[BLOCK] ? all[BLOCK] : {};
    }

    /**
     * 標準に設定されているプリセット名を取得
     *
     * @returns {string} プリセット名。未設定なら空文字
     */
    function getDefaultName() {
      var defaults = wp.data.select("core/preferences").get(DEFAULT_SCOPE, "defaults");

      return defaults && defaults[BLOCK] ? defaults[BLOCK] : "";
    }

    /**
     * 標準にするプリセット名を保存
     *
     * 空文字を指定すると標準設定を解除
     *
     * @param {string} value プリセット名
     * @returns {void}
     */
    function setDefaultName(value) {
      var defaults = wp.data.select("core/preferences").get(DEFAULT_SCOPE, "defaults");
      var next = Object.assign({}, defaults);

      if (value) {
        next[BLOCK] = value;
      } else {
        delete next[BLOCK];
      }

      wp.data.dispatch("core/preferences").set(DEFAULT_SCOPE, "defaults", next);
    }

    /**
     * プリセット対応ブロックの保存先を初期化する高階コンポーネントを登録
     *
     * Xwriteはプリセットの保存先が存在しない場合、
     * プリセット名の入力時にObject.values(undefined)で例外が発生
     *
     * @param {Function} BlockEdit 元のブロック編集コンポーネント
     * @returns {Function} 拡張したブロック編集コンポーネント
     */
    function withEnsuredPresets(BlockEdit) {
      /**
       * ブロック選択時にプリセットの保存先を用意
       *
       * @param {Object} props ブロック編集コンポーネントのプロパティ
       * @returns {Object} React要素
       */
      function EnsuredPresetsEdit(props) {
        var name = props.name;
        var selected = props.isSelected;

        /**
         * プリセットの保存先が存在しない場合に空の保存先を登録
         *
         * @returns {void}
         */
        function ensurePresetStore() {
          if (!selected || ensured.has(name) || name.indexOf("xwrite/") !== 0) {
            return;
          }

          // プリセット機能に対応していないブロックは処理対象外
          if (!wp.blocks.getBlockSupport(name, "xwriteBlockPreset")) {
            return;
          }

          // 初期読み込み中は既存の設定を変更しない
          if (!isEditorReady()) {
            return;
          }

          var all = wp.data.select("core/preferences").get(PRESET_SCOPE, "blockPresets");

          // 保存先が既にある場合は初期化済みとして処理を終了
          if (all && all[name]) {
            ensured.add(name);
            return;
          }

          // 他のブロックのプリセットを保持したまま保存先を追加
          var next = Object.assign({}, all);
          next[name] = {};

          wp.data.dispatch("core/preferences").set(PRESET_SCOPE, "blockPresets", next);
          ensured.add(name);
        }

        wp.element.useEffect(ensurePresetStore, [selected, name]);

        return el(BlockEdit, props);
      }

      return EnsuredPresetsEdit;
    }

    // プリセット保存先の初期化処理を登録
    wp.hooks.addFilter(
      "editor.BlockEdit",
      "xwc/ensure-block-presets",
      wp.compose.createHigherOrderComponent(withEnsuredPresets, "xwcEnsureBlockPresets")
    );

    /**
     * ふき出しの保存済みプリセット名をJSON文字列で取得
     *
     * useSelectの再描画判定で配列の参照が毎回変わることを防止
     *
     * @param {Function} select ストアのセレクター取得関数
     * @returns {string} プリセット名のJSON文字列
     */
    function selectPresetNames(select) {
      var all = select("core/preferences").get(PRESET_SCOPE, "blockPresets");

      return JSON.stringify(all && all[BLOCK] ? Object.keys(all[BLOCK]) : []);
    }

    /**
     * 標準に設定されているプリセット名を取得
     *
     * @param {Function} select ストアのセレクター取得関数
     * @returns {string} プリセット名。未設定なら空文字
     */
    function selectDefaultName(select) {
      var defaults = select("core/preferences").get(DEFAULT_SCOPE, "defaults");

      return defaults && defaults[BLOCK] ? defaults[BLOCK] : "";
    }

    /**
     * 標準プリセットを選択する設定パネルを生成
     *
     * @returns {Object} React要素
     */
    function DefaultPresetPanel() {
      var namesJson = wp.data.useSelect(selectPresetNames, []);
      var current = wp.data.useSelect(selectDefaultName, []);
      var names = JSON.parse(namesJson);

      // 標準を設定しない選択肢を登録
      var options = [
        { label: "なし(標準にしない)", value: "" }
      ];

      // 保存済みのプリセットを選択肢に追加
      names.forEach(function (name) {
        options.push({
          label: name,
          value: name
        });
      });

      // 選択中のプリセットが削除されている場合も設定を保持
      if (current && names.indexOf(current) === -1) {
        options.push({
          label: current + "(未登録)",
          value: current
        });
      }

      return el(
        wp.blockEditor.InspectorControls,
        null,
        el(
          wp.components.PanelBody,
          {
            title: "新規挿入時の標準",
            initialOpen: true
          },
          el(wp.components.SelectControl, {
            label: "標準にするプリセット",
            value: current,
            options: options,
            help: names.length
              ? "新しく挿入したふきだしに、このプリセットを自動で適用します。"
              : "先に上の「プリセット」で設定を保存してください。",
            onChange: setDefaultName,
            __nextHasNoMarginBottom: true,
            __next40pxDefaultSize: true
          })
        )
      );
    }

    /**
     * ふき出しの設定パネルに標準プリセットの選択欄を追加する高階コンポーネントを登録
     *
     * @param {Function} BlockEdit 元のブロック編集コンポーネント
     * @returns {Function} 拡張したブロック編集コンポーネント
     */
    function withDefaultPresetPanel(BlockEdit) {
      /**
       * ふき出しが選択されている場合に設定パネルを表示
       *
       * @param {Object} props ブロック編集コンポーネントのプロパティ
       * @returns {Object} React要素
       */
      function PanelEdit(props) {
        var show = props.name === BLOCK && props.isSelected;

        return el(
          wp.element.Fragment,
          null,
          show ? el(DefaultPresetPanel, null) : null,
          el(BlockEdit, props)
        );
      }

      return PanelEdit;
    }

    // 標準プリセットの設定パネルを登録
    wp.hooks.addFilter(
      "editor.BlockEdit",
      "xwc/fukidashi-default-panel",
      wp.compose.createHigherOrderComponent(withDefaultPresetPanel, "xwcFukidashiDefaultPanel"),
      9
    );

    // 前回取得したブロック一覧を保持
    var lastBlocks = null;

    /**
     * ブロックの木構造を入れ子も含めて順にたどる
     *
     * @param {Object[]} blocks ブロックの配列
     * @param {Function} callback 各ブロックに対して実行する処理
     * @returns {void}
     */
    function walkBlocks(blocks, callback) {
      blocks.forEach(function (block) {
        callback(block);

        if (block.innerBlocks && block.innerBlocks.length) {
          walkBlocks(block.innerBlocks, callback);
        }
      });
    }

    /**
     * 値が未設定または空かどうかを判定
     *
     * @param {*} value 判定する値
     * @returns {boolean} 空ならtrue
     */
    function isEmptyValue(value) {
      return value === undefined || value === null || value === "" ||
        (Array.isArray(value) && value.length === 0);
    }

    /**
     * ふき出しが新規挿入直後の状態か判定
     *
     * 本文・アイコン・名前が空で、左寄せの場合を対象
     *
     * @param {Object} block 判定するブロック
     * @returns {boolean} 挿入直後の状態ならtrue
     */
    function isPristine(block) {
      var attributes = block.attributes || {};

      return isEmptyValue(attributes.content) &&
        isEmptyValue(attributes.mediaURL) &&
        isEmptyValue(attributes.mediaName) &&
        (attributes.position === undefined || attributes.position === "balloon_l");
    }

    /**
     * 新規挿入された空のふき出しに標準プリセットを適用
     *
     * @returns {void}
     */
    function applyDefaultPreset() {
      var editor = wp.data.select("core/block-editor");

      // エディターのデータ取得APIが利用できない場合は処理を終了
      if (!editor) {
        return;
      }

      var blocks = editor.getBlocks();

      // ブロック一覧に変更がなければ処理を終了
      if (blocks === lastBlocks) {
        return;
      }

      lastBlocks = blocks;

      var isReady = isEditorReady();
      var targets = [];

      /**
       * 新しく追加されたふき出しを適用対象として収集
       *
       * @param {Object} block 判定するブロック
       * @returns {void}
       */
      function collectTarget(block) {
        if (block.name !== BLOCK || handled.has(block.clientId)) {
          return;
        }

        // 適用の有無にかかわらず一度だけ判定
        handled.add(block.clientId);

        // 読み込み完了後に追加された空のふきだしだけを対象にする
        if (isReady && isPristine(block)) {
          targets.push(block.clientId);
        }
      }

      walkBlocks(blocks, collectTarget);

      // 適用対象がない場合は処理を終了
      if (!targets.length) {
        return;
      }

      // 標準に設定されたプリセットを取得
      var name = getDefaultName();
      var preset = name ? getPresets()[name] : null;

      // プリセットまたは属性が存在しない場合は処理対象外
      if (!preset || !preset.attributes) {
        return;
      }

      var dispatch = wp.data.dispatch("core/block-editor");

      // 自動適用を独立した取り消し履歴として記録しないよう設定
      if (typeof dispatch.__unstableMarkNextChangeNotPersistent === "function") {
        dispatch.__unstableMarkNextChangeNotPersistent();
      }

      // 対象のふきだしにプリセットの属性を適用
      dispatch.updateBlockAttributes(
        targets,
        Object.assign({}, preset.attributes)
      );
    }

    // ブロックの変更を監視する処理を登録
    wp.data.subscribe(applyDefaultPreset);
  })(window.wp);
  <?php
  wp_add_inline_script('wp-edit-post', ob_get_clean());
});

さいごに

今回紹介した方法を使えば、Xwriteの「ふき出し」ブロックに任意のプリセットをデフォルトとして設定できます。
新しく挿入したふき出しにも、登録済みのアイコンや配置などを自動適用できるため、毎回プリセットを呼び出す手間を省けます。よく使うふき出しの設定がある場合は、ぜひ活用してみてください。

タイトルとURLをコピーしました