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

お勧め

Emojin：プラグイン作ってみました（2015年3月21日 更新）

ちょっと前のTLでiOSの絵文字を含んだ投稿を保存すると、絵文字以降の文章がすべて消えた状態で保存されるといったツイートを見かけた。少し検索してみると、MySQLのデータベースの文字セットが「utf8」の場合、iOSの絵文字のような4バイトの文字を正常に保存できず、それ以降の文章も保存されないというものらしい。対処方法としてデータベースの文字セットを「utf8mb4」に変更するのが有効らしいのだが、他に回避策がないか考えてみた。

Twenty Seventeenのフォントサイズを変更してみた（2021年12月15日 更新）

先日投稿した「続テーマを変更せずにWebフォントを使ってみた」では、テーマ「Twenty Seventeen」でもWebフォントを使えるようにした。その際、「Twenty Seventeen」のフォントサイズが少し小さく感じたので、今回はフォントサイズを調整してみた。

HTML entities button：プラグイン作ってみました（2021年4月28日 更新）

以前投稿した「HTML編集モードに定型文ボタンを追加する」をアレンジして、HTML編集モードに特殊文字（HTMLエンティティ）を挿入できるボタン、顔文字を挿入できるボタン、過去の投稿ページのリンクを挿入できるボタンを追加するプラグインを作ってみました。HTML編集モードの作業効率を向上させるプラグインです。2.1.0では「Dashiconsの挿入」を追加しました。HTML編集モードをメインに使用されている方は、お試しあれ。

5.7の機能拡張：エクスポートファイルに更新日時が追加ほか（2021年2月23日 更新）

WordPressはサイト移行を支援する機能として投稿情報のエクスポート機能を備えている。5.7ではこのエクスポート機能が改良され、更新日時情報が追加されるようだ。

query_posts（WP_Queryクラス）でカスタムフィールドを使う（2011年9月15日 更新）

先週3回にわたってtax_queryパラメータを使ったカテゴリーや投稿タグ、投稿フォーマットの絞り込みを整理したが、その途中で目に付いたのが'meta_query'パラメータ。この'meta_query'パラメータは、カスタムフィールドの絞り込み条件を指定するためのもので、3.2で登場した新しいパラメータのようだ。