描述
默认情况下,会回显登录表单HTML。为$echo
传递一个false值以返回它。
参数
- $args
-
(array) (可选) A用于控制表单输出的选项数组。
- 'echo'
(bool) 是显示登录表单还是返回表单的 HTML 代码,默认 true (输出显示) - 'redirect'
(string) 要重定向到的URL,必须是绝对地址,如 "https://example.com/mypage/". 默认重定向回请求的URI - 'form_id'
(string) 表单的ID属性值,默认 'loginform' - 'label_username'
(string) username 或 email 地址字段的label(标签),默认 'Username 或 Email Address' - 'label_password'
(string) password 字段的label,默认 'Password' - 'label_remember'
(string) remember 字段的label,默认 'Remember Me' - 'label_log_in'
(string) submit 按钮的label,默认 'Log In' - 'id_username'
(string) username 字段的ID属性值,默认 'user_login' - 'id_password'
(string) password 字段的ID属性值,默认 'user_pass' - 'id_remember'
(string) remember 字段的ID属性值,默认 'rememberme' - 'id_submit'
(string) submit 按钮的ID属性值,默认 'wp-submit' - 'remember'
(bool) 是否在表单中显示 "rememberme" 复选框 - 'value_username'
(string) username 字段的默认值 - 'value_remember'
(bool) "Remember Me" 复选框是否要默认选中,默认 false (不选中)
默认值: array()
- 'echo'
返回
(void|string) 如果'echo'参数为true,则无返回;如果'echo'为false,则返回登录表单的 HTML。
源码
更新日志
版本 | 描述 |
---|---|
3.0.0 | 开始引入 |
使用示例
此示例显示登录表单。
<?php wp_login_form(); ?>
我发现这个函数经常被WP 5.3的admin_email_check更新破坏,导致静默登录失败。如果遇到静默登录失败,请尝试禁用管理员电子邮件检查。
// 禁用管理员电子邮箱验证
add_filter( ‘admin_email_check_interval’, ‘__return_false’ );本例将登录表单显示为短代码([wpdocs_log_me])。
function wpdocs_log_me_shortcode_fn() { $args = array( 'echo' => true, 'redirect' => get_permalink( get_the_ID() ), 'remember' => true, 'value_remember' => true, ); return wp_login_form( $args ); } add_shortcode( 'wpdocs_log_me', 'wpdocs_log_me_shortcode_fn' );