云策 WordPress 开发者社区

钩子文档

login_form_defaults

查看官方原文 ↗
💡 云策文档标注

概述

login_form_defaults 是一个 WordPress 过滤器，用于修改 wp_login_form() 函数中默认登录表单参数的数组。它允许开发者自定义登录表单的标签、ID 等设置。

关键要点

  • 这是一个过滤器钩子，用于过滤 wp_login_form() 函数的默认参数数组。
  • 参数 $defaults 是一个数组，包含如 'label_username'、'label_password'、'form_id' 等键值对。
  • 通过 add_filter() 添加回调函数来修改这些默认值，例如更改标签文本。

代码示例

add_filter( 'login_form_defaults', 'my_login_page' );

function my_login_page($defaults) {
	$defaults['label_username'] = __( 'Enter Username' );
	$defaults['label_password'] = __( 'Enter Password' );
	$defaults['label_remember'] = __( 'Remember Login State' );
	$defaults['label_log_in'] = __( 'Please Log In' );

	return $defaults;
}
📄 原文内容

Filters the default login form output arguments.

Description

See also

Parameters

$defaultsarray
An array of default login form arguments.

More Information

The defaults set in the wp_login_form() function are as follows:

$defaults = array(
'echo' => true,
'redirect' => ( is_ssl() ? 'https://' : 'http://' ) . $_SERVER['HTTP_HOST'] . $_SERVER['REQUEST_URI'],
'form_id' => 'loginform',
'label_username' => __( 'Username' ),
'label_password' => __( 'Password' ),
'label_remember' => __( 'Remember Me' ),
'label_log_in' => __( 'Log In' ),
'id_username' => 'user_login',
'id_password' => 'user_pass',
'id_remember' => 'rememberme',
'id_submit' => 'wp-submit',
'remember' => true,
'value_username' => '',
'value_remember' => false, // Set this to true to default the "Remember me" checkbox to be checked.
);

Source

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

View all references View on Trac View on GitHub

Used by Description
wp_login_form()wp-includes/general-template.php

Provides a simple login form for use anywhere within WordPress.

Changelog

Version Description
3.0.0 Introduced.

User Contributed Notes

  1. Skip to note 2 content


    Steven Lin


    You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

    Example migrated from Codex:

    The following example changes the default labels in the wp_login_form() function:

    add_filter( 'login_form_defaults', 'my_login_page' );

function my_login_page($defaults) {
	$defaults['label_username'] = __( 'Enter Username' );
	$defaults['label_password'] = __( 'Enter Password' );
	$defaults['label_remember'] = __( 'Remember Login State' );
	$defaults['label_log_in'] = __( 'Please Log In' );

	return $defaults;
}