get_user_locale() の使い方|説明・引数・注意点

説明

get_user_locale() は、ユーザーの言語(プロフィールで選んだ言語)を取得する関数です。設定がなければ、サイトの言語を返します。

基本構文

get_user_locale( int|WP_User $user = 0 ): string

引数

  • $user:ユーザーのIDまたはオブジェクト(省略すると、現在のユーザー)

戻り値

ロケールの文字列。

使い方(サンプル)

$locale = get_user_locale();

注意点

  • ユーザーが、言語を選んでいないときは、サイトの言語になります。
  • そのリクエストで使う言語を、判定するときは、determine_locale()。

実務での使いどころ

  • 管理画面で、ユーザーの言語に合わせて、表示を変えるとき。
  • メール通知を、ユーザーの言語で、送るとき。

よくあるミスと対処

  • サイトの言語を使うべき場面で、使っている(表示言語が、人によって変わる)。
  • ログインしていないときの動作を、考えていない。

NG例

$locale = get_locale(); // ユーザーの言語のつもり

OK例

$locale = get_user_locale( $user_id );

使い分け早見表

関数 返す言語
get_user_locale() ユーザーの言語
get_locale() サイトの言語
determine_locale() そのリクエストで、使うべき言語

関連項目

get_locale()、determine_locale()

公式リファレンス:get_user_locale() | WordPress Developer Resources

コメント

タイトルとURLをコピーしました