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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。

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

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

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。