wp_login_form

パラメータ

• $args
  ログインフォームの各種パラメータを指定（連想配列）。キーワードは次の通り。

  キーワード	省略時の値	意味
  echo	true	フォームを表示する場合はtrue、HTMLテキストを取得する場合はfalseを指定
  redirect	site_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
  remember	true	ログイン情報を記録チェックボックスを表示する場合はtrue、表示しない場合はfalseを指定
  value_username	''	ユーザー名入力ボックスの初期値
  value_remember	false	ログイン情報を記録チェックボックスの初期値
  required_username	false	[6.6.0]ユーザー名入力ボックスにrequired属性をつける場合はtrueを指定
  required_password	false	[6.6.0]パスワード入力ボックスにrequired属性をつける場合はtrueを指定

返り値

注意

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

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

使用例

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

フィルター

$args = wp_parse_args( $args, apply_filters( 'login_form_defaults', $defaults ) );

$login_form_top = apply_filters( 'login_form_top', $content, $args );

$login_form_middle = apply_filters( 'login_form_middle', $content, $args );

$login_form_bottom = apply_filters( 'login_form_bottom', $content, $args );

アクション

ソースファイル