The get_the_generator_{$type} filter allows you to modify the generator meta tag provided by WordPress in certain contexts.
It is evaluated in get_the_generator() in the wp-includes/general-template.php file.
get_the_generator_{$type} is a dynamic filter, meaning part of the filter tag changes based on the context. It accepts 2 arguments:
- string
$genThe generator meta tag - string
$typeThe generator type
The dynamic portion of the filter tag, $type accepts html, xhtml (default), atom, rss2, rdf, comment, or export. When you add your filter, the tag takes the form of get_the_generator_html or get_the_generator_xhtml and so on.
Example:
Sometimes people will use a filter to disable the generator tag altogether, termed “security by obscurity”. The following example instead tries to have a little fun with the generator tag by replacing the WordPress version number with its corresponding jazz musician! We’ll filter on the default xhtml context.
| <?php | |
| /** | |
| * WordPress versions to jazz musicians | |
| * | |
| * @param string $gen The generator meta tag. | |
| * @param string $type The type of page to generate the tag for. | |
| * | |
| * @return string The filtered generator meta tag. | |
| */ | |
| function wpdocs_generator_as_jazzer( $gen, $type ) { | |
| // Jazz musicians to their respective release versions | |
| // The leading space in the verisons are to avoid | |
| // false positives from point releases in the strpos(). | |
| $jazzers = array( | |
| ' 1.0' => 'Miles Davis', ' 1.2' => 'Charles Mingus', | |
| ' 1.5' => 'Billy Strayhorn', ' 2.0' => 'Duke Ellington', | |
| ' 2.1' => 'Ella Fitzgerald', ' 2.2' => 'Stan Getz', | |
| ' 2.3' => 'Dexter Gordon', ' 2.5' => 'Michael Brecker', | |
| ' 2.6' => 'McCoy Tyner', ' 2.7' => 'John Coltrane', | |
| ' 2.8' => 'Chet Baker', ' 2.9' => 'Carmen McRae', | |
| ' 3.0' => 'Thelonious Monk', ' 3.1' => 'Django Reinhardt', | |
| ' 3.2' => 'George Gershwin', ' 3.3' => 'Sonny Stitt', | |
| ' 3.4' => 'Grant Green', ' 3.5' => 'Elvin Jones' | |
| ); | |
| foreach ( $jazzers as $version => $name ) { | |
| if ( strpos( $gen, $version ) ) | |
| $jazzer = $name; | |
| } | |
| if ( empty( $jazz ) ) | |
| $jazzer = 'Jazz'; | |
| // Outputs 'WordPress to the sounds of [Musician] or Jazz' | |
| $jazzer = sprintf( esc_attr__( 'WordPress to the sounds of %s', 'yourtextdomain' ), $jazzer ); | |
| return '<meta content="' . $jazzer . '" name="generator">'; | |
| } | |
| add_filter( 'get_the_generator_xhtml', 'wpdocs_generator_as_jazzer', 10, 2 ); |
by
This is a great project, thank you for your work on this.
If I could just offer one suggestion, it would be to use a function prefix in your sample code, like for example fotd_. So the above function would then be named fotd_mess_with_the_generator.
I know that this is just demonstration code, but unfortunately a lot of people just copy-paste the whole thing and just change the innards of the function, not the rest. So this is why I think it would be best to write as you would for a real project, even if it is just sample code.
This is something I would like to see being used consistently in the Codex and other tutorials as well.
That’s a pretty valid point. I generally try to use a fake textdomain to promote responsible localization, so I guess it hadn’t occurred to me that I should be prefixing in this context as well.
I’ll have to figure out what prefix I could use instead of ‘fotd’. Maybe ‘docs’ or something — mostly so I don’t have to re-prefix when examples get transferred to the Codex/Code Reference in the future.
Using a ‘wpdocs’ prefix is a lot better than my suggestion. Thanks for implementing this!
Week 1 Recap: Filters 1-12 – Filters of the Day