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



お勧め

CSSやJavaScriptファイルのバージョン番号を変える(2018年5月27日 更新)

WordPress 4.7系の脆弱性をついた攻撃も落ち着いた感じなので、標準でヘッダーやフッター内に出力されるWordPressのバージョン番号について一考しました。

テーブルブロックを投稿メタ(カスタムフィールド)に保存する(2022年1月5日 更新)

ふと「テーブルブロックの内容を投稿メタ(カスタムフィールド)として保存できたら便利なのでは」と思い、投稿メタの使い方を調べてみた。

カスタム投稿タイプの投稿保存には専用アクションを使おう(2014年7月4日 更新)

カスタム投稿タイプを登録して、専用ウィジェット(meta_box)を使って拡張情報を入力させ、それらの情報をsave_postアクションで保存する。これまではこんな感じだったのだが、久しぶりにカスタム投稿タイプを使ったら、save_postアクションの前にsave_postに投稿タイプ名がくっついたアクションが追加されていた。

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

5.3への準備:投稿写真を使っているサイトは準備しておこう(2019年10月10日 更新)

この記事は先日公開した「5.3の新機能:JPEG画像の向きを調整」の続きのようなものになる。高解像度の投稿写真を扱っているサイトは、5.3のリリースに合わせて対応を検討しておくべきことをまとめてみた。