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

概要

__フィルタは、翻訳テキストを取得するために使用されるWordPressの国際化機能の一部です。このフィルタは、テーマやプラグインの翻訳可能なテキストを取得する際によく利用されます。以下は、__フィルタがよく使われる主な機能です：

1. テキストの翻訳
2. 多言語サイトの構築
3. ユーザーインターフェースの国際化
4. プラグインの翻訳サポート
5. テーマの翻訳対応
6. 管理画面の翻訳
7. カスタムポストタイプのラベル翻訳
8. プラグイン設定の翻訳

構文

__($text, $domain);

パラメータ

• $text: 翻訳が必要な文字列
• $domain: テキストドメイン（任意）

戻り値

• 翻訳された文字列

関連する関数

関連する関数

使用可能なバージョン

__フィルタはWordPress 1.2以降の全バージョンで使用可能です。

コアファイルのパス

wp-includes/l10n.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: プラグインのタイトル翻訳

function my_custom_plugin_name() {
    return __('My Custom Plugin', 'my-plugin-text-domain');
}

このコードは、プラグイン名を翻訳可能にするために使用されます。

サンプルコード 2: テーマのヘッダーの翻訳

function my_theme_logo() {
    echo '<h1>' . __('Welcome to My Site', 'my-theme-text-domain') . '</h1>';
}

このコードは、テーマのヘッダー部分で「Welcome to My Site」を翻訳可能にします。

サンプルコード 3: カスタム投稿タイプのラベル翻訳

function my_custom_post_type() {
    register_post_type('my_post_type', array(
        'labels' => array(
            'name' => __('My Post Types', 'my-plugin-text-domain')
        ),
        ...
    ));
}

このコードは、カスタム投稿タイプの名前を翻訳可能にします。

サンプルコード 4: カスタムメニューの翻訳

function my_custom_menu() {
    add_menu_page(__('Custom Settings', 'my-plugin-text-domain'), 'custom-settings', 'manage_options', 'custom-settings', 'my_custom_settings_page');
}

このコードは、カスタム設定メニューのタイトルを翻訳可能にします。

サンプルコード 5: プラグイン設定画面の翻訳

function my_plugin_settings_page() {
    echo '<h2>' . __('Plugin Settings', 'my-plugin-text-domain') . '</h2>';
}

このコードは、プラグイン設定画面のタイトルを翻訳可能にします。