プラグインElementorのelementor/elements/elements_registeredアクションの使用方法・解説

概要

elementor/elements/elements_registered アクションフックは、Elementorがカスタムエレメントを登録する際に使用されます。このフックを用いることで、開発者は独自のウィジェットやエレメントを追加することができます。新しいエレメントを作成する際に特に役立ちます。

このアクションは以下のような機能を実装する際に使用されることが一般的です：

カスタムウィジェットの追加
既存のウィジェットの拡張
エレメントの動的コンテンツの登録
エレメントに特定のスタイルやスクリプトの追加
ユーザーインターフェースのカスタマイズ
特定のデータソースからの情報の表示

構文

add_action('elementor/elements/elements_registered', 'your_custom_function');

パラメータ

このアクションにはパラメータはありませんが、作用する際には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_action('elementor/elements/elements_registered', function($elements_manager) {
    require_once('path/to/your/custom-widget.php');
    $elements_manager->add_category('custom-category', [
        'title' => __('Custom Widgets', 'your-text-domain'),
        'icon' => 'fa fa-plug',
    ]);
});

このコードは、Elementorにカスタムウィジェットのカテゴリを追加します。

引用元: https://developers.elementor.com/docs/widgets/creating-a-widget/

サンプル2: ウィジェットの登録

add_action('elementor/elements/elements_registered', function($elements_manager) {
    $elements_manager->register(new YourNamespaceYourCustomWidget());
});

このサンプルは、独自のウィジェットクラスを登録します。

引用元: https://developers.elementor.com/docs/widgets/

サンプル3: カスタムエディタースタイルの追加

add_action('elementor/elements/elements_registered', function($elements_manager) {
    add_action('elementor/editor/after_enqueue_styles', function() {
        wp_enqueue_style('your-custom-style', 'path/to/style.css');
    });
});

このコードは、Elementorのエディターにカスタムスタイルを追加します。

引用元: https://developers.elementor.com/docs/advanced/adding-custom-editor-styles/

サンプル4: エレメントのカスタムボタン

add_action('elementor/elements/elements_registered', function($elements_manager) {
    $elements_manager->register(new YourNamespaceCustomButtonWidget());
});

このサンプルは、カスタムボタンウィジェットをElementorに登録する方法を示しています。

引用元: https://developers.elementor.com/docs/widgets/create-a-widget/

サンプル5: 動的データのエレメント

add_action('elementor/elements/elements_registered', function($elements_manager) {
    require_once('path/to/dynamic-content-widget.php');
    $elements_manager->register(new YourNamespaceDynamicDataWidget());
});

このコードは、動的データを表示するウィジェットを追加するためのものです。

引用元: https://developers.elementor.com/docs/widgets/advanced/

以上で、elementor/elements/elements_registered アクションの説明とサンプルコードを提供しました。

概要

構文