wpmu_signup_user_notification() - WordPress 函数参考中文文档

返回介绍

wpmu_signup_user_notification()

发布于 2017-09-11 字数5924 浏览 910 评论 0

wpmu_signup_user_notification( string $user_login,  string $user_email,  string $key,  array $meta = array() )

Notify user of signup success.


描述

This is the notification function used when no new site has been requested.

Filter ‘wpmu_signup_user_notification’ to bypass this function or replace it with your own notification behavior.

Filter ‘wpmu_signup_user_notification_email’ and ‘wpmu_signup_user_notification_subject’ to change the content and subject line of the email sent to newly registered users.


参数

$user_login

(string)
(Required)
The user’s login name.

$user_email

(string)
(Required)
The user’s email address.

$key

(string)
(Required)
The activation key created in wpmu_signup_user()

$meta

(array)
(Optional)
Signup meta data.

Default value: array()


返回值

(bool)


源代码

File: wp-includes/ms-functions.php

function wpmu_signup_user_notification( $user_login, $user_email, $key, $meta = array() ) {
	/**
	 * Filters whether to bypass the email notification for new user sign-up.
	 *
	 * @since MU
	 *
	 * @param string $user_login User login name.
	 * @param string $user_email User email address.
	 * @param string $key        Activation key created in wpmu_signup_user().
	 * @param array  $meta       Signup meta data. Default empty array.
	 */
	if ( ! apply_filters( 'wpmu_signup_user_notification', $user_login, $user_email, $key, $meta ) )
		return false;

	$user = get_user_by( 'login', $user_login );
	$switched_locale = switch_to_locale( get_user_locale( $user ) );

	// Send email with activation link.
	$admin_email = get_site_option( 'admin_email' );
	if ( $admin_email == '' )
		$admin_email = 'support@' . $_SERVER['SERVER_NAME'];
	$from_name = get_site_option( 'site_name' ) == '' ? 'WordPress' : esc_html( get_site_option( 'site_name' ) );
	$message_headers = "From: \"{$from_name}\" <{$admin_email}>\n" . "Content-Type: text/plain; charset=\"" . get_option('blog_charset') . "\"\n";
	$message = sprintf(
		/**
		 * Filters the content of the notification email for new user sign-up.
		 *
		 * Content should be formatted for transmission via wp_mail().
		 *
		 * @since MU
		 *
		 * @param string $content    Content of the notification email.
		 * @param string $user_login User login name.
		 * @param string $user_email User email address.
		 * @param string $key        Activation key created in wpmu_signup_user().
		 * @param array  $meta       Signup meta data. Default empty array.
		 */
		apply_filters( 'wpmu_signup_user_notification_email',
			__( "To activate your user, please click the following link:\n\n%s\n\nAfter you activate, you will receive *another email* with your login." ),
			$user_login, $user_email, $key, $meta
		),
		site_url( "wp-activate.php?key=$key" )
	);
	// TODO: Don't hard code activation link.
	$subject = sprintf(
		/**
		 * Filters the subject of the notification email of new user signup.
		 *
		 * @since MU
		 *
		 * @param string $subject    Subject of the notification email.
		 * @param string $user_login User login name.
		 * @param string $user_email User email address.
		 * @param string $key        Activation key created in wpmu_signup_user().
		 * @param array  $meta       Signup meta data. Default empty array.
		 */
		apply_filters( 'wpmu_signup_user_notification_subject',
			/* translators: New user notification email subject. 1: Network name, 2: New user login */
			_x( '[%1$s] Activate %2$s', 'New user notification email subject' ),
			$user_login, $user_email, $key, $meta
		),
		$from_name,
		$user_login
	);
	wp_mail( $user_email, wp_specialchars_decode( $subject ), $message, $message_headers );

	if ( $switched_locale ) {
		restore_previous_locale();
	}

	return true;
}

更新日志

Version 描述
MU Introduced.

相关函数

Uses

  • wp-includes/l10n.php:
    restore_previous_locale()
  • wp-includes/l10n.php:
    switch_to_locale()
  • wp-includes/l10n.php:
    get_user_locale()
  • wp-includes/l10n.php:
    __()
  • wp-includes/l10n.php:
    _x()
  • wp-includes/formatting.php:
    esc_html()
  • wp-includes/formatting.php:
    wp_specialchars_decode()
  • wp-includes/pluggable.php:
    get_user_by()
  • wp-includes/pluggable.php:
    wp_mail()
  • wp-includes/link-template.php:
    site_url()
  • wp-includes/plugin.php:
    apply_filters()
  • wp-includes/option.php:
    get_site_option()
  • wp-includes/option.php:
    get_option()
  • wp-includes/ms-functions.php:
    wpmu_signup_user_notification
  • wp-includes/ms-functions.php:
    wpmu_signup_user_notification_email
  • wp-includes/ms-functions.php:
    wpmu_signup_user_notification_subject
  • Show 11 more uses
    Hide more uses


User Contributed Notes

  1. Skip to note content

    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

    Contributed by fschroiff

    The data stored in $meta is a serialized array, so make sure you unserialize it before trying to use its data.

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

目前还没有任何评论,快来抢沙发吧!