wp_login_form

説明

string wp_login_form( mixed $args )
シンプルなログインフォームを表示する。パラメータ$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ログイン情報を記録チェックボックスの初期値

返り値

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

注意

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

使用例

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

最終更新 : 2018年05月27日 10:50



お勧め

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

oEmbedについて考えてみた(2018年5月27日 更新)

本サイト向けにテーマをリニューアルしようと思い一から作っている最中、ふと生成されているHTMLの中にあるoEmbedの記述が目についた。「この記述いつからだっけ」くらいに思いながらリンク先を開き、ちょっとモヤモヤしてしまった。

一定時間でログアウトする(2013年5月23日 更新)

ログイン関係を調べている関係で、 wp_set_auth_cookie関数に行き着く。ログイン画面の「ログイン状態を保持する」がチェックされた場合、クッキーの有効期限は14日間。チェックされていない場合は、ブラウザが閉じるまで常に有効となっているんだね。