WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

is_user_spammy()

is_user_spammy( string|WP_User $user = null ): bool

In this article

Back to top

Determines whether a user is marked as a spammer, based on user login.

Parameters

$userstring|WP_Useroptional
Defaults to current user. WP_User object, or user login name as a string.

Default:null

Return

bool

Source

function is_user_spammy( $user = null ) {
	if ( ! ( $user instanceof WP_User ) ) {
		if ( $user ) {
			$user = get_user_by( 'login', $user );
		} else {
			$user = wp_get_current_user();
		}
	}

	return $user && isset( $user->spam ) && 1 == $user->spam;
}

View all references View on Trac View on GitHub

UsesDescription
get_user_by()wp-includes/pluggable.php

Retrieves user info by a given field.

wp_get_current_user()wp-includes/pluggable.php

Retrieves the current user object.

Used byDescription
wp_is_password_reset_allowed_for_user()wp-includes/user.php

Checks if password reset is allowed for a specific user.

wp_authenticate_spam_check()wp-includes/user.php

For Multisite blogs, checks if the authenticated user has been marked as a spammer, or if the user’s primary blog has been marked as spam.

Changelog

VersionDescription
MU (3.0.0)Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.