概要
the_author
フィルタは、ワードプレスで投稿者名を表示する際によく使用されるフィルタです。このフィルタは、投稿者名を出力する前に、その表示内容を変更するために使われます。主に次のような機能を実装する際に利用されます:
- 投稿者名のフォーマットを変更
- 投稿者名の前後にテキストを追加
- 特定の条件に基づいて投稿者名をハイライト
- 投稿者名をカスタムに置き換え
- 投稿者の役職や肩書きを追加
- 特定のユーザーグループの管理
- SEO対策としてのメタデータの変更
- 投稿者名の言語による条件分岐
構文
add_filter('the_author', 'your_custom_function');
パラメータ
the_author
: 投稿者名を含む文字列。your_custom_function
: 投稿者名を変更するためのカスタム関数。
戻り値
- フィルタによって変更された投稿者名の文字列。
関連する関数
https://refwp.com/?titleonly=1&s=the_author
使用可能なバージョン
the_author
フィルタは、WordPress 1.5以降で使用可能です。
コアファイルのパス
/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('the_author', 'custom_author_name');
function custom_author_name($author) {
return '著者: ' . $author;
}
このコードは、投稿者名の前に「著者: 」というテキストを追加します。
サンプルコード2
add_filter('the_author', 'highlight_author_name');
function highlight_author_name($author) {
return '<strong>' . $author . '</strong>';
}
このコードは、投稿者名を太字で表示します。
サンプルコード3
add_filter('the_author', 'replace_author_name');
function replace_author_name($author) {
if ($author === '特定のユーザー名') {
return '別の名前';
}
return $author;
}
このコードは、特定の投稿者名を別の名前に置き換えます。
サンプルコード4
add_filter('the_author', 'add_title_to_author_name');
function add_title_to_author_name($author) {
return $author . '(編集者)';
}
このコードは、投稿者名の後に「(編集者)」というテキストを追加します。
サンプルコード5
add_filter('the_author', 'customize_author_display');
function customize_author_display($author) {
// カスタム条件に基づいて投稿者名を変更
if (is_single() && in_the_loop()) {
return strtoupper($author); // 投稿者名を大文字に変換
}
return $author;
}
このコードは、単一の投稿が表示されている場合にのみ、投稿者名を大文字に変換します。
注意
特定のワードプレスバージョンでフィルタが非推奨または削除された場合、特定の情報はありません。