云策 WordPress 开发者社区

钩子文档

login_headertext

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

概述

login_headertext 是一个 WordPress 过滤器钩子，用于自定义登录页面头部徽标链接的文本内容。开发者可以通过此钩子修改显示在登录表单上方的链接文本。

关键要点

  • login_headertext 钩子允许过滤登录页面头部徽标的链接文本。
  • 参数为字符串类型的 $login_header_text，表示原始链接文本。
  • 钩子通过 apply_filters 调用，位于 wp-login.php 的 login_header() 函数中。
  • 自 WordPress 5.2.0 版本引入，相关钩子 login_headertitle 已被弃用。

代码示例

// 自定义登录头部文本。
add_filter( 'login_headertext', 'wpdoc_customize_login_headertext' );

function wpdoc_customize_login_headertext( $headertext ) {
	$headertext = esc_html__( 'Welcome to WordPress', 'plugin-textdomain' );
	return $headertext;
}

注意事项

注意：相关钩子 login_headertitle 已被弃用，建议使用 login_headertext 进行自定义。

📄 原文内容

Filters the link text of the header logo above the login form.

Parameters

$login_header_textstring
The login header logo link text.

Source

$login_header_text = apply_filters( 'login_headertext', $login_header_text );

View all references View on Trac View on GitHub

Used by Description
login_header()wp-login.php

Outputs the login page header.

Changelog

Version Description
5.2.0 Introduced.

User Contributed Notes

  2. Skip to note 4 content


    thejaydip


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

    An example of login header logo title.

    function wpdocs_login_logo_url_title( $text ) {
    $text = get_bloginfo( 'name' ) . ' | ' . get_bloginfo( 'description' );
    return $text;
}
add_filter( 'login_headertitle', 'wpdocs_login_logo_url_title' );