ワードプレスのthe_embed_site_titleフィルタの使用方法・解説

概要

the_embed_site_titleフィルタは、エンベッドテンプレート向けにサイトタイトルを表示する際に役立ちます。このフィルタを使用することで、特定の条件に基づきサイトのタイトルを変更したり、カスタマイズしたりすることができます。具体的には、以下のような場面でよく使われます：

1. サイトタイトルの翻訳やローカライズ。
2. デザインに応じたタイトルのスタイル変更。
3. サイトの特定の部分でのタイトル情報の強調。
4. 特定の投稿タイプに対するカスタムタイトルの表示。
5. SEO目的でのタイトルの変更。
6. ランディングページ用にタイトルを特化させる。
7. サイトマップやRSSフィードでの異なるタイトル表示。
8. 管理画面や特定のウィジェット内での競合回避。

構文

add_filter('the_embed_site_title', 'your_callback_function');

パラメータ

• $title (string): 現在のサイトタイトル。
• $post (WP_Post): 投稿オブジェクト（オプション）。

戻り値

• (string): 変更されたサイトタイトル。

関連する関数

the_embed_site_title

使用可能なバージョン

このフィルタはWordPress 4.4以降で使用可能です。

コアファイルパス

wp-includes/embed.php

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

アクション	使用可能性
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('the_embed_site_title', function($title) {
    return 'カスタムサイトタイトル';
});

このサンプルは、エンベッドされたコンテンツで表示されるサイトのタイトルを “カスタムサイトタイトル” に変更します。

サンプル2: 投稿タイプによるタイトルの変更

add_filter('the_embed_site_title', function($title, $post) {
    if ($post->post_type === 'page') {
        return 'カスタムページタイトル';
    }
    return $title;
}, 10, 2);

このサンプルは、エンベッドされたページに対して特定のタイトルを表示します。ページ以外の投稿タイプの場合は元のタイトルを使用します。

サンプル3: 言語に基づいたタイトルのローカライズ

add_filter('the_embed_site_title', function($title) {
    if (is_rtl()) {
        return 'عنوان الموقع';
    }
    return $title;
});

このサンプルは、RTL（右から左）の言語環境のときにサイトタイトルをアラビア語に変更します。

サンプル4: SEO対策

add_filter('the_embed_site_title', function($title) {
    return $title . ' - 私たちの最高のコンテンツ';
});

このサンプルは、SEOを向上させるためにサイトタイトルに説明を追加します。

サンプル5: 特定条件下でのカスタマイズ

add_filter('the_embed_site_title', function($title) {
    if (is_mobile()) {
        return 'モバイル版タイトル';
    }
    return $title;
});

このサンプルは、モバイルデバイスからのアクセス時に異なるサイトタイトルを表示します。