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

概要

get_the_generatorフィルタは、WordPressにおけるメタ情報の一部であるgeneratorタグを取得する際に用いられます。このフィルタを使用すると、出力されるgeneratorタグの内容を変更することができます。generatorタグは、通常、WordPressのバージョンを示す情報を含んでいますが、このフィルタを活用することで、開発者が独自の文字列を設定することが可能です。

get_the_generatorフィルタは以下のような機能を実装する際によく使われます:

  1. SEO対策 – 元のWordPressバージョンを隠すことができ、安全性を向上させる。
  2. カスタムCMS – 特定のニーズに合わせたCMSの構築を支援。
  3. メンテナンスモード – 特定のバージョンを示す場合に便利。
  4. プラグイン開発 – プラグインが生成する情報をカスタマイズ。
  5. セキュリティ – 未知の攻撃から保護するためにバージョン情報を隠す。
  6. オリジナルサイト表示 – 鍵となるメタ情報をサイトのブランディングに合わせて調整。
  7. 互換性管理 – 特定のバージョンタグを出力して、他のシステムとの互換性を保つ。
  8. デバッグツール – 開発やテスト環境での適切な情報提示。

構文

add_filter('get_the_generator', 'custom_generator');

パラメータ

  • $generator: 生成されるgeneratorタグのデフォルト値(文字列)。

戻り値

  • 変更されたgeneratorタグ(文字列)。

関連する関数

使用可能なバージョン

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

コアファイルのパス

  • wp-includes/general-template.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('get_the_generator', 'hide_wordpress_version');
function hide_wordpress_version() {
    return 'My Custom CMS';
}

このコードは、WordPressのバージョン情報を「My Custom CMS」という文字列に変更し、一般にその情報を隠します。

引用元: https://developer.wordpress.org/reference/functions/add_filter/

  1. カスタムメッセージを追加
add_filter('get_the_generator', 'custom_generator_message');
function custom_generator_message() {
    return 'Powered by My Custom Framework';
}

このコードは、出力されるgeneratorタグに「Powered by My Custom Framework」というカスタムメッセージを追加します。

引用元: https://developer.wordpress.org/reference/functions/add_filter/

  1. 特定条件に応じた変更
add_filter('get_the_generator', 'conditional_generator');
function conditional_generator() {
    if (is_user_logged_in()) {
        return 'Welcome back, user!';
    }
    return 'My Static Site';
}

このコードは、ユーザーがログインしている場合にメッセージを変更し、それ以外は「My Static Site」というメッセージを表示します。

引用元: https://developer.wordpress.org/reference/functions/add_filter/

  1. タイムスタンプを追加
add_filter('get_the_generator', 'timestamped_generator');
function timestamped_generator() {
    return 'My Site - ' . date('Y-m-d H:i:s');
}

このコードは、generatorタグに現在のタイムスタンプを追加します。

引用元: https://developer.wordpress.org/reference/functions/add_filter/

  1. SEO向けの独自の文字列
add_filter('get_the_generator', 'seo_friendly_generator');
function seo_friendly_generator() {
    return 'My SEO Friendly Site';
}

このコードは、SEO対策としてgeneratorタグに「My SEO Friendly Site」という文字列を設定します。

引用元: https://developer.wordpress.org/reference/functions/add_filter/

この関数について質問する


上の計算式の答えを入力してください