プラグインElementorのelementor/utils/get_placeholder_image_src関数の使用方法・解説

概要

関数 elementor/utils/get_placeholder_image_src は、Elementor プラグインの中でプレースホルダー画像の URL を取得するために使用されます。この関数は、主に以下の状況で利用されることが一般的です。

ウィジェットのデフォルト画像を指定したい場合
デモコンテンツに使用する画像を設定する場合
利用可能なサンプルデータを提供する際
ビジュアルエディタでプレビューを表示する場合
テーマやプラグインの設定ページで画像選択肢を表示する場合
画像のない状態をエミュレートしてテストを行う場合

構文

get_placeholder_image_src();

パラメータ

この関数は引数を受け取らないため、パラメータはありません。

戻り値

この関数は、プレースホルダー画像の URL を表す文字列を返します。

バージョン情報

Elementor バージョン: 3.0 以降
WordPress バージョン: 5.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: ウィジェットでのプレースホルダー画像の利用

// Elementorのウィジェットクラスにおいてデフォルト画像を取得
class Sample_Widget extends ElementorWidget_Base {
    public function get_image_placeholder() {
        return get_placeholder_image_src();
    }
}

// 利用方法
$widget = new Sample_Widget();
echo $widget->get_image_placeholder(); // プレースホルダー画像のURLを出力

このサンプルは、Elementor のカスタムウィジェット内でプレースホルダー画像の URL を取得し、表示する方法を示しています。

サンプルコード2: デモ用画像の設定

// デモデータの配列にプレースホルダー画像を追加
function add_demo_content() {
    $demo_content = [
        'title' => 'My Demo Content',
        'image' => get_placeholder_image_src(),
    ];
    return $demo_content;
}

// 利用方法
$demo = add_demo_content();
echo $demo['image']; // デモ画像のURLを出力

このサンプルは、デモコンテンツを作成する際にプレースホルダー画像を利用する方法を示しています。

サンプルコード3: テーマのオプションページでの画像設定

// テーマオプションでプレースホルダー画像を設定
function theme_options_settings() {
    $options = get_option('my_theme_options');
    $options['default_image'] = get_placeholder_image_src();
    update_option('my_theme_options', $options);
}

// 実行
theme_options_settings();

このサンプルは、WordPress のテーマオプションページでデフォルト画像を設定する際に、プレースホルダー画像を使用する方法を示しています。

サンプルコード4: プレビュー用の画像表示

// ビジュアルエディタでのプレビュー画像
function render_preview_image() {
    echo '<img src="' . get_placeholder_image_src() . '" alt="Preview Image">';
}

// 利用方法
render_preview_image(); // プレースホルダー画像を表示

このサンプルは、ビジュアルエディタ内でプレビュー画像としてプレースホルダー画像を表示する方法を示しています。

サンプルコード5: テスト用の画像の取得

// テスト条件でプレースホルダー画像を表示
function test_placeholder_image() {
    if ( !has_post_thumbnail() ) {
        echo '<img src="' . get_placeholder_image_src() . '" alt="Placeholder Image">';
    }
}

// 実行
test_placeholder_image(); // 投稿にサムネイルがない場合にプレースホルダー画像を表示

このサンプルは、投稿にサムネイルが設定されていない場合に、プレースホルダー画像を表示する方法を示しています。

これらのサンプルコードは、elementor/utils/get_placeholder_image_src 関数をさまざまなコンテキストで利用する方法を示しています。これらはすべて著作権フリーのものです。

概要

構文