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

概要

the_generatorフィルタは、WordPressのヘッダーセクションに出力されるgeneratorタグを表示する際に使われるフィルタです。このフィルタを利用することで、WordPressのバージョン情報をカスタマイズしたり、他の情報を埋め込むことができます。以下のような機能実装に利用されることが一般的です。

1. 特定のバージョン情報の非表示化
2. カスタムテキストの挿入
3. サイトのフレームワーク情報の追加
4. SEO対策のための情報修正
5. セキュリティの強化
6. テーマの詳細情報の表示
7. 開発中の情報の出力
8. プラグインのバージョン情報の表示

構文

add_filter('the_generator', 'custom_generator_function');

function custom_generator_function($generator) {
    return 'カスタム情報';
}

パラメータ

• $generator: デフォルトのバージョン情報（文字列）を含む。

戻り値

• カスタマイズされた生成者情報（文字列）。

関連する関数

the_generatorフィルタについて

使用可能なバージョン

• WordPress 1.5以降

コアファイルのパス

wp-includes/general-template.php

サンプルコード

サンプルコード1: デフォルトのgeneratorタグを非表示にする

add_filter('the_generator', '__return_empty_string');

このサンプルコードは、WordPressのデフォルトのgeneratorタグを空の文字列に置き換え、出力されないようにしています。

サンプルコード2: カスタムバージョン情報を追加

add_filter('the_generator', 'custom_generator_function');
function custom_generator_function($generator) {
    return 'My Custom Framework v1.0';
}

このサンプルコードでは、元のgeneratorタグを独自のフレームワークの情報に置き換えています。

サンプルコード3: SEO対策としてのgenerator情報制御

add_filter('the_generator', function($generator) {
    return 'Custom SEO Generator Info';
});

SEO対策として、標準のWordPressバージョン情報をカスタムテキストに置き換えています。

サンプルコード4: サイト名を追加したgeneratorタグ

add_filter('the_generator', function($generator) {
    return get_bloginfo('name') . ' - ' . $generator;
});

このコードは、generatorタグにサイト名を追加して出力します。

サンプルコード5: 特定の条件下でのみgeneratorタグを表示

add_filter('the_generator', function($generator) {
    if (is_user_logged_in()) {
        return $generator; // ログインユーザーにのみ表示
    }
    return '';
});

このサンプルコードは、ログインユーザーにのみデフォルトのgeneratorタグを表示します。

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

アクション名	使用例
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	〇

非推奨もしくは削除されたバージョン

• 特に非推奨または削除されたバージョンはありません。