概要
get_the_author_meta関数は、WordPressの投稿者情報を取得するための関数です。この関数を使用することにより、特定のユーザーに関連するメタデータ（例: ユーザー名、メールアドレス、説明文など）を取得することができます。以下は、この関数がどのような機能を実装する際によく使われるかの例です。
- 投稿者の表示名を取得するため。
- 投稿者のプロフィール画像を表示する際の情報取得。
- 投稿者の自己紹介を表示するため。
- 投稿者のウェブサイトのURLを表示するため。
- 投稿者の連絡先情報を表示するため。
- 投稿者のSNSリンクを表示する際の情報取得。
- 特定のユーザー情報を基にしたカスタム表示を行うため。
- 投稿者に関連する情報をカスタムフィールドに基づいて表示するため。
構文
get_the_author_meta( $field, $user_id );
パラメータ
$field: 取得したいメタデータのフィールド名（例: ‘ID’, ‘user_nicename’, ‘display_name’, ‘user_email’ など）。$user_id（任意）: 取得するユーザーのID。指定しない場合は現在の投稿の著者IDが使用されます。
戻り値
指定されたフィールド名のメタデータ。また、存在しないフィールドの場合はfalseを返します。
関連する関数
使用可能なバージョン
この関数はWordPress 2.0.0以降で使用可能です。
コアファイルのパス
wp-includes/user.php
サンプルコード
サンプル1: 投稿者の表示名を取得する
<?php
// 現在の投稿の投稿者の表示名を取得
echo get_the_author_meta('display_name');
このコードは、表示している投稿の著者の表示名を取得して表示します。
サンプル2: 投稿者のメールアドレスを取得する
<?php
// 投稿者のメールアドレスを取得
$email = get_the_author_meta('user_email');
if ($email) {
echo "メールアドレス: " . esc_html($email);
}
このコードは、著者のメールアドレスを取得し、確認の上で表示します。
サンプル3: 投稿者のURLを取得する
<?php
// 投稿者のウェブサイトURLを取得
$website = get_the_author_meta('user_url');
if ($website) {
echo "ウェブサイト: <a href='" . esc_url($website) . "'>" . esc_html($website) . "</a>";
}
このコードは、著者のウェブサイトURLを取得し、リンクとして表示します。
サンプル4: 投稿者の自己紹介を表示する
<?php
// 投稿者の自己紹介文を取得
$description = get_the_author_meta('description');
if ($description) {
echo "<p>自己紹介: " . esc_html($description) . "</p>";
}
このコードは、著者の自己紹介文を取得して表示します。
サンプル5: 投稿者のIDを取得する
<?php
// 投稿者のユーザーIDを取得
$user_id = get_the_author_meta('ID');
echo "投稿者のID: " . esc_html($user_id);
このコードは、著者のユーザーIDを取得して表示します。
この関数のアクションでの使用可能性
| アクション | 使用例 |
|---|---|
| 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 |
非推奨または削除情報
現時点で、get_the_author_meta関数が非推奨または削除された特定のWordPressバージョンはありません。