既存ウィジェットエリアにウィジェットをコピーする方法

はじめに

新しく作成したウィジェットエリアに配置したウィジェットを、特定の既存ウィジェットエリアに自動でコピーします。

例えば、ウィジェットの表示サンプルを複数のウィジェットエリアに登録・確認するのは手間がかかります。

そこで、一つのウィジェットエリアにだけ登録しておけば、表示条件に応じて他エリアにコピー表示されるようにすることで、作業効率を大幅に改善できます。

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

完成イメージ

実装手順

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

新設したウィジェットエリア「サンプル用」のウィジェットを、条件に応じ各ウィジェットエリアにコピーします。

// ウィジェットエリアを追加
add_action('widgets_init', function () {
  register_sidebar([
    'name'        => 'サンプル用',
    'id'          => 'widget_sample',
    'description' => 'コピー元のウィジェットです。',
  ]);
});


// ウィジェットエリアの構成を変更
add_filter('sidebars_widgets', function ($sidebars_widgets) {
  if (is_admin()) {
    return $sidebars_widgets;
  }

  // 共通ウィジェットを取得
  $source_widgets = $sidebars_widgets['widget_sample'] ?? [];

  // コピー先と表示条件を設定
  $targets = [
    'sidebar'                  => is_single(9478),
    'single-content-top'       => is_single(9467),
    'above-single-sns-buttons' => is_single(9449),
    'below-single-sns-buttons' => is_single(16255),
    'content-bottom'           => is_single(9462),
    'footer-right'             => is_single(8535),
    'index-bottom'             => is_category(45),
  ];

  foreach ($targets as $target_id => $condition) {
    if (!$condition) {
      continue;
    }

    $sidebars_widgets[$target_id] = array_merge(
      $sidebars_widgets[$target_id] ?? [],
      $source_widgets
    );
  }

  return $sidebars_widgets;
});

参考：Cocoonのウィジェットエリアのインデックス名

表1に、ウィジェットエリアのインデックス名一覧を示します。

cocoon/lib/widget-areas.php at master · xserver-inc/cocoon

100％GPLの無料WordPressテーマです。開発中の開発バージョンです。安定版をダウンロードする場合は、Cocoon配布サイトからダウンロードしてください。 - xserver-inc/cocoon

github.com

さいごに

今回紹介した方法を使えば、新しく作成したウィジェットエリアに登録したウィジェットを、特定の条件に応じて既存のエリアへ自動でコピーできるようになります。
この手法を活用することで、ウィジェットの表示確認や設定の手間を省き、作業効率を大幅に向上させることができます。