プラグインElementorのelementor/template-library/get_template_label_by_type関数の使用方法・解説

概要

elementor/template-library/get_template_label_by_type 関数は、Elementor プラグインで使用される関数の一つです。この関数は、特定のテンプレートタイプに関連付けられたラベルを取得するために使用されます。以下によく使われる機能を挙げます。

テンプレートの種類ごとのラベルをカスタマイズ
テキスト翻訳のサポート
管理画面でのテンプレート一覧表示
UX向上のためのテンプレートタイプ識別
テンプートライブラリとの統合
テンプレート投稿タイプの設定

構文

string get_template_label_by_type( $type );

パラメータ

$type (string): テンプレートの種類を指定します。

戻り値

(string): 指定されたテンプレートタイプに関連付けられたラベルの文字列。

使用可能なプラグインおよびバージョン

Elementor プラグインバージョン: 3.0 以上
WordPress バージョン: 5.5 以上

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

アクション	使用例
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: テンプレートのラベルを取得

$template_type = 'section';
$template_label = get_template_label_by_type( $template_type );

echo 'テンプレートタイプ: ' . $template_type . ' ラベル: ' . $template_label;

このコードは、指定されたテンプレートタイプに対するラベルを取得し、そのラベルを表示します。特定のテンプレートに関連する情報を取得したい場合に役立ちます。

サンプルコード2: テンプレート一覧にラベルを表示

function display_template_labels( $templates ) {
    foreach ( $templates as $template ) {
        $label = get_template_label_by_type( $template->post_type );
        echo '<div>' . $label . ': ' . $template->post_title . '</div>';
    }
}

このコードは、渡されたテンプレートのリストに対して、それぞれのテンプレートラベルを取得し表示します。テンプレートの情報を整理して見やすくする際によく使用されます。

サンプルコード3: 管理画面でのラベル使用

add_action( 'admin_init', function() {
    $type = 'global';
    $label = get_template_label_by_type( $type );
    add_settings_section( 'template_section', $label, null, 'general' );
});

この例では、管理画面の設定セクションにおいて、指定したテンプレートタイプに基づいたラベルを表示します。設定画面のウィジェットに役立つ情報を追加できます。

サンプルコード4: テンプレートラベルの翻訳

function translate_template_label( $type ) {
    $label = get_template_label_by_type( $type );
    return __( $label, 'your-text-domain' );
}

このコードは、取得したテンプレートラベルを翻訳するために使用されます。国際化を考慮したアプリケーションに適しています。

サンプルコード5: テンプレートタイプの識別

function identify_template_type( $template_id ) {
    $type = get_post_type( $template_id );
    $label = get_template_label_by_type( $type );
    return 'このテンプレートは: ' . $label;
}

この例では、特定のテンプレート ID からそのタイプを識別し、そのラベルを取得して表示します。特定のテンプレート情報を管理したいときに便利です。

引用元のページは、Elementor の公式ドキュメントや GitHub などから参照できますが、具体的なリンクを示すことはできません。

概要

構文