wp_login_form

（3.0.0以降）
wp_login_form - ログインフォームを表示する

説明

void | string wp_login_form( [ array $args = array() ] )
シンプルなログインフォームを表示する。パラメータ$argsに'echo'=>falseが指定された場合は、表示せずにそのHTMLテキストを取得する。

パラメータ

  • $args
    ログインフォームの各種パラメータを指定（連想配列）。キーワードは次の通り。
    キーワード省略時の値意味
    echotrueフォームを表示する場合はtrue、HTMLテキストを取得する場合はfalseを指定
    redirectsite_url( $_SERVER['REQUEST_URI'] )ログイン後の戻り先URL
    from_id'loginform'fromタグのID
    label_username__( 'Username' )ユーザー名ラベルのテキスト（日本語環境の省略時は'ユーザー名'）
    label_password__( 'Password' )パスワードラベルのテキスト（日本語環境の省略時は'パスワード'）
    label_remember__( 'Remember Me' )ログイン情報を記録チェックボックスのテキスト（日本語環境の省略時は'ログイン情報を記録'）
    label_log_in__( 'Log In' )ログインボタンのテキスト（日本語環境の省略時は'ログイン'）
    id_username'user_login'ユーザー名入力ボックスのID
    id_password'user_pass'パスワード入力ボックスのID
    id_remember'rememberme'ログイン情報を記録チェックボックスのID
    id_submit'wp-submit'ログインボタンのID
    remembertrueログイン情報を記録チェックボックスを表示する場合はtrue、表示しない場合はfalseを指定
    value_username''ユーザー名入力ボックスの初期値
    value_rememberfalseログイン情報を記録チェックボックスの初期値
    required_usernamefalse[6.6.0]ユーザー名入力ボックスにrequired属性をつける場合はtrueを指定
    required_passwordfalse[6.6.0]パスワード入力ボックスにrequired属性をつける場合はtrueを指定

返り値

パラメータ$argsに'echo'=>falseが指定された場合は、表示せずにそのHTMLテキストを返す。

注意

wp_login_url関数は、サイトのログインページのURLを表示・取得するが、この関数は（シンプルな）ログインフォームそのものを表示・取得できる。

[6.6.0]パラメータ$argsにキー'required_username'と'required_password'が追加された。

使用例

  • ログインフォームを表示する。
    <?php wp_login_form( ); ?>
  • ログイン情報を記録チェックボックスを省いてログインフォームを表示する。
    <?php wp_login_form( array( 'remember'=>false ) ); ?>

フィルター

[3.0.0]本関数のパラメータ$argsにデフォルト値を適用する前に'login_form_defaults'フィルターを呼び出す。パラメータ$defaultsには各キーのデフォルト値が格納されている。 
$args = wp_parse_args( $args, apply_filters( 'login_form_defaults', $defaults ) );
[3.0.0]ログインフォームの上部に挿入するコンテンツのために'login_form_top'フィルターを呼び出す。パラメータ$contentには''が格納されている。 
$login_form_top = apply_filters( 'login_form_top', $content, $args );
[3.0.0]ログインフォームの中ほど（パスワードとリメンバーの間）に挿入するコンテンツのために'login_form_middle'フィルターを呼び出す。パラメータ$contentには''が格納されている。 
$login_form_middle = apply_filters( 'login_form_middle', $content, $args );
[3.0.0]ログインフォームの下部に挿入するコンテンツのために'login_form_bottom'フィルターを呼び出す。パラメータ$contentには''が格納されている。 
$login_form_bottom = apply_filters( 'login_form_bottom', $content, $args );

アクション

直接実行するアクションはありません。

ソースファイル

/wp-includes/general-template.php

最終更新 : 2024年07月18日 13:48

関連

参考

Code Reference: wp_login_form

お勧め

投稿情報を連想配列で参照する（2018年5月27日 更新）

投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。

WordPressのコーディングスタンダードとPSR-2がかみ合わない（2018年5月27日 更新）

先日パソコンのストレージを換装して開発環境を再構築。エディタのEclipseは「Neon（4.6）」から「Oxygen（4.7）」へ切り替わった。コードを書き始めるとそこはかとなく違和感があり、調べていくとPHPの「Code Style（Formatter）」が「PSR-2」に設定されていることが原因だった。

続テーマを変更せずにWebフォントを使ってみた（2022年2月8日 更新）

先日投稿した「テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Twenty One」でWebフォントを使うことができた。その後、ほかのテーマで試したところ、そのままではWebフォントを使うことができなかった。今回は、それらのテーマの対応について紹介する。

ブロックエディターで現在の「ロケール」を取得した時のメモ（2024年8月10日 更新）

ブロックエディター向けのプラグインで日本語固有の機能を実装する際、現在のロケール（言語）を取得したい。ブロックエディターの編集時、投稿を編集しているユーザーの言語が優先され、それをどうやって取得するかを「ChatGPT」に聞いてみたのだが。。。

スマートフォン向けの振り分けを自前で行う（2012年1月23日 更新）

PC向けのサイトをスマートフォン対応する場合、WPtouchやktai styleに代表されるスマートフォン対応のテンプレート切り替えプラグインを使用するのが一般的。そういったプラグインはテンプレート切り替え以外の機能も備えており、そういった機能は必ずしも必要ではない。そんなわけで、ここでは超シンプルなスマートフォン向けのテンプレート切り替えを実現する方法を紹介する。