プラグインElementorのelementor/editor/localize_settingsフィルタの使用方法・解説

概要

elementor/editor/localize_settings フィルタは、Elementor プラグインのエディタ内で使用される設定をローカライズするためのフックです。このフィルタを通じて、管理者はエディタの動作をカスタマイズしたり、新しい設定を追加したりすることが可能です。特に、次のような機能を実装する際によく使われます：

エディタ内のカスタムメッセージの表示
特定のユーザー権限に基づく設定の変更
特定の条件下でのオプションの有効化/無効化
カスタムスクリプトやスタイルのロード
言語ファイルの追加
デフォルト値の変更

構文

add_filter('elementor/editor/localize_settings', 'my_custom_localize_settings');

パラメータ

$settings: Elementor エディタの設定を含む配列。

戻り値

カスタマイズされた設定値を含む配列。

使用可能なバージョン

Elementor: 2.0.0 以上
WordPress: 4.0 以上

この関数のアクションでの使用可能性

アクション	使用可能性
mu_plugin_loaded
registered_post_type
plugins_loaded
wp_roles_init
setup_theme
after_setup_theme
set_current_user
init
register_sidebar
wp_loaded
send_headers
parse_query
pre_get_posts
wp
template_redirect
get_header
wp_head

サンプルコード

サンプル 1: カスタムメッセージを追加

add_filter('elementor/editor/localize_settings', function($settings) {
    $settings['customMessage'] = __('これはカスタムメッセージです', 'your-text-domain');
    return $settings;
});

このサンプルコードは、Elementor エディタにカスタムメッセージを追加します。このメッセージは、指定されたテキストドメインに翻訳可能です。

サンプル 2: ユーザー権限に基づく設定変更

add_filter('elementor/editor/localize_settings', function($settings) {
    if (!current_user_can('administrator')) {
        $settings['isAdmin'] = false;
    }
    return $settings;
});

このサンプルコードは、現在のユーザーが管理者でない場合に、isAdmin 設定を false に変更します。

サンプル 3: デフォルトのカスタムスタイルを追加

add_filter('elementor/editor/localize_settings', function($settings) {
    $settings['customStyles'] = ['color' => '#ff0000', 'fontSize' => '16px'];
    return $settings;
});

このコードでは、Elementor エディタにデフォルトのカスタムスタイルを追加します。ここでは、テキストの色とフォントサイズを指定しています。

サンプル 4: 特定の条件でオプションの有効化

add_filter('elementor/editor/localize_settings', function($settings) {
    if (is_product()) {
        $settings['enableSpecialFeature'] = true;
    }
    return $settings;
});

このサンプルは、WooCommerce の商品ページで特別な機能を有効にする際に使用されます。

サンプル 5: 言語ファイルの追加

add_filter('elementor/editor/localize_settings', function($settings) {
    $settings['languages'] = ['ja', 'en'];
    return $settings;
});

このサンプルコードは、Elementor エディタに言語ファイルを追加します。ここでは、日本語と英語を指定しています。

これらのサンプルコードは、Elementor プラグインの機能をカスタマイズする際の参考になります。

概要

構文