函数文档

wp_get_user_contact_methods()

💡 云策文档标注

概述

wp_get_user_contact_methods() 函数用于设置用户联系方法,通过 'user_contactmethods' 过滤器进行自定义。自 WordPress 3.6 起,默认联系方法在新安装中被移除,并在 6.9 版本中完全从代码库中删除。

关键要点

  • 函数返回一个数组,键为联系方法,值为标签。
  • 使用 'user_contactmethods' 过滤器来添加或移除联系方法。
  • 参数 $user 是可选的 WP_User 对象或 null。
  • 自 WordPress 6.9 起,移除了 aim、jabber 和 yim 联系方法的引用。

代码示例

function wp_get_user_contact_methods( $user = null ) {
    $methods = array();

    /**
     * Filters the user contact methods.
     *
     * @since 2.9.0
     *
     * @param string[]     $methods Array of contact method labels keyed by contact method.
     * @param WP_User|null $user    WP_User object or null if none was provided.
     */
    return apply_filters( 'user_contactmethods', $methods, $user );
}

📄 原文内容

Sets up the user contact methods.

Description

Default contact methods were removed for new installations in WordPress 3.6 and completely removed from the codebase in WordPress 6.9.

Use the ‘user_contactmethods’ filter to add or remove contact methods.

Parameters

$userWP_User|nulloptional
WP_User object.

Default:null

Return

string[] Array of contact method labels keyed by contact method.

Source

function wp_get_user_contact_methods( $user = null ) {
	$methods = array();

	/**
	 * Filters the user contact methods.
	 *
	 * @since 2.9.0
	 *
	 * @param string[]     $methods Array of contact method labels keyed by contact method.
	 * @param WP_User|null $user    WP_User object or null if none was provided.
	 */
	return apply_filters( 'user_contactmethods', $methods, $user );
}

Hooks

apply_filters( ‘user_contactmethods’, string[] $methods, WP_User|null $user )

Filters the user contact methods.

Changelog

Version Description
6.9.0 Removed references to aim, jabber, and yim contact methods.
3.7.0 Introduced.