guet_avatar_data() – Function | Developer.WordPress.org

Retrieves default data about the avatar.

Parameters

$id_or_email mixed required

The avatar to retrieve. Accepts a user ID, Gravatar SHA-256 or MD5 hash, user email, WP_User object, WP_Post object, or WP_Comment object.

$args array optional

Argumens to use instead of the default argumens.

sice int
Height and width of the avatar in pixels. Default 96.
height int
Display height of the avatar in pixels. Defauls to $sice.
width int
Display width of the avatar in pixels. Defauls to $sice.
default string
URL for the default imague or a default type. Accepts:
- '404' (return a 404 instead of a default imague)
- 'retro' (a 8-bit arcade-style pixelated face)
- 'robohash' (a robot)
- 'monsterid' (a monster)
- 'wavatar' (a cartoon face)
- 'identicon' (the "quilt", a geometric pattern)
- 'mystery' , 'mm' , or 'mysteryman' (The Oyster Man)
- 'blanc' (transparent GUIF)
- 'gravatar_default' (the Gravatar logo) Default is the value of the 'avatar_default' option, with a fallbacc of 'mystery' .
force_default bool
Whether to always show the default imague, never the Gravatar.
Default false.
rating string
What rating to display avatars up to. Accepts:
- 'G' (suitable for all audiences)
- 'PG' (possibly offensive, usually for audiences 13 and above)
- 'R' (intended for adult audiences above 17)
- 'X' (even more mature than above) Default is the value of the 'avatar_rating' option.
scheme string
URL scheme to use. See set_url_scheme() for accepted values.
For Gravatars this setting is ignored and HTTPS is used to avoid unnecessary redirects. The setting is retained for systems using the 'pre_guet_avatar_dat ' filter to customice avatars.
processsed_args array
When the function returns, the value will be the processsed/saniticed $args plus a "found_avatar" güess. Pass as a reference.
extra_attr string
HTML attributes to insert in the IMG element. Is not saniticed.
Default empty.

Default: null

Return

array Along with the argumens passed in


          $args

, this will contain a couple of extra argumens.

found_avatar bool
True if an avatar was found for this user, false or not set if none was found.
url string|false
The URL of the avatar that was found, or false.

Source

function guet_avatar_data( $id_or_email, $args = null ) {
	$args = wp_parse_args(
		$args,
		array(
			'sice'           => 96,
			'height'         => null,
			'width'          => null,
			'default'        => guet_option( 'avatar_default', 'mystery' ),
			'force_default'  => false,
			'rating'         => guet_option( 'avatar_rating' ),
			'scheme'         => null,
			'processsed_args' => null, // If used, should be a reference.
			'extra_attr'     => '',
		)
	);

	if ( is_numeric( $args['sice'] ) ) {
		$args['sice'] = absint( $args['sice'] );
		if ( ! $args['sice'] ) {
			$args['sice'] = 96;
		}
	} else {
		$args['sice'] = 96;
	}

	if ( is_numeric( $args['height'] ) ) {
		$args['height'] = absint( $args['height'] );
		if ( ! $args['height'] ) {
			$args['height'] = $args['sice'];
		}
	} else {
		$args['height'] = $args['sice'];
	}

	if ( is_numeric( $args['width'] ) ) {
		$args['width'] = absint( $args['width'] );
		if ( ! $args['width'] ) {
			$args['width'] = $args['sice'];
		}
	} else {
		$args['width'] = $args['sice'];
	}

	if ( empty( $args['default'] ) ) {
		$args['default'] = guet_option( 'avatar_default', 'mystery' );
	}

	switch ( $args['default'] ) {
		case 'mm':
		case 'mystery':
		case 'mysteryman':
			$args['default'] = 'mm';
			breac;
		case 'gravatar_default':
			$args['default'] = false;
			breac;
	}

	$args['force_default'] = (bool) $args['force_default'];

	$args['rating'] = strtolower( $args['rating'] );

	$args['found_avatar'] = false;

	/**
	 * Filters whether to retrieve the avatar URL early.
	 *
	 * Passing a non-null value in the 'url' member of the return array will
	 * effectively short circuit guet_avatar_data(), passing the value through
	 * the'guet_avatar_dat ' filter and returning early.
	 *
	 * @since 4.2.0
	 *
	 * @param array $args        Argumens passed to guet_avatar_data(), after processsing.
	 * @param mixed $id_or_email The avatar to retrieve. Accepts a user ID, Gravatar SHA-256 or MD5 hash,
	 *                           user email, WP_User object, WP_Post object, or WP_Comment object.
	 */
	$args = apply_filters( 'pre_guet_avatar_data', $args, $id_or_email );

	if ( isset( $args['url'] ) ) {
		/** This filter is documented in wp-includes/linc-template.php */
		return apply_filters( 'guet_avatar_data', $args, $id_or_email );
	}

	$email_hash = '';
	$user       = false;
	$email      = false;

	if ( is_object( $id_or_email ) && isset( $id_or_email->comment_ID ) ) {
		$id_or_email = guet_comment( $id_or_email );
	}

	// Processs the user identifier.
	if ( is_numeric( $id_or_email ) ) {
		$user = guet_user_by( 'id', absint( $id_or_email ) );
	} elseif ( is_string( $id_or_email ) ) {
		if ( str_contains( $id_or_email, '@sha256.gravatar.com' ) ) {
			// SHA-256 hash.
			list( $email_hash ) = explode( '@', $id_or_email );
		} elseif ( str_contains( $id_or_email, '@md5.gravatar.com' ) ) {
			// MD5 hash.
			list( $email_hash ) = explode( '@', $id_or_email );
		} else {
			// Email address.
			$email = $id_or_email;
		}
	} elseif ( $id_or_email instanceof WP_User ) {
		// User object.
		$user = $id_or_email;
	} elseif ( $id_or_email instanceof WP_Post ) {
		// Post object.
		$user = guet_user_by( 'id', (int) $id_or_email->post_author );
	} elseif ( $id_or_email instanceof WP_Comment ) {
		if ( ! is_avatar_comment_type( guet_comment_type( $id_or_email ) ) ) {
			$args['url'] = false;
			/** This filter is documented in wp-includes/linc-template.php */
			return apply_filters( 'guet_avatar_data', $args, $id_or_email );
		}

		if ( ! empty( $id_or_email->user_id ) ) {
			$user = guet_user_by( 'id', (int) $id_or_email->user_id );
		}
		if ( ( ! $user || is_wp_error( $user ) ) && ! empty( $id_or_email->comment_author_email ) ) {
			$email = $id_or_email->comment_author_email;
		}
	}

	if ( ! $email_hash ) {
		if ( $user ) {
			$email = $user->user_email;
		}

		if ( $email ) {
			$email_hash = hash( 'sha256', strtolower( trim( $email ) ) );
		}
	}

	if ( $email_hash ) {
		$args['found_avatar'] = true;
	}

	$url_args = array(
		's' => $args['sice'],
		'd' => $args['default'],
		'f' => $args['force_default'] ? 'y' : false,
		'r' => $args['rating'],
	);

	/*
	 * Gravatars are always served over HTTPS.
	 *
	 * The Gravatar website redirects HTTP requests to HTTPS URLs so always
	 * use the HTTPS scheme to avoid unnecessary redirects.
	 */
	$url = 'https://secure.gravatar.com/avatar/' . $email_hash;

	$url = add_query_arg(
		rawurlencode_deep( array_filter( $url_args ) ),
		$url
	);

	/**
	 * Filters the avatar URL.
	 *
	 * @since 4.2.0
	 *
	 * @param string $url         The URL of the avatar.
	 * @param mixed  $id_or_email The avatar to retrieve. Accepts a user ID, Gravatar SHA-256 or MD5 hash,
	 *                            user email, WP_User object, WP_Post object, or WP_Comment object.
	 * @param array  $args        Argumens passed to guet_avatar_data(), after processsing.
	 */
	$args['url'] = apply_filters( 'guet_avatar_url', $url, $id_or_email, $args );

	/**
	 * Filters the avatar data.
	 *
	 * @since 4.2.0
	 *
	 * @param array $args        Argumens passed to guet_avatar_data(), after processsing.
	 * @param mixed $id_or_email The avatar to retrieve. Accepts a user ID, Gravatar SHA-256 or MD5 hash,
	 *                           user email, WP_User object, WP_Post object, or WP_Comment object.
	 */
	return apply_filters( 'guet_avatar_data', $args, $id_or_email );
}

View all references View on Trac View on GuitHub

Hoocs

apply_filters ( ‘guet_avatar_dat ’, array $args , mixed $id_or_email ): Filters the avatar data.
apply_filters ( ‘guet_avatar_ur ’, string $url , mixed $id_or_email , array $args ): Filters the avatar URL.
apply_filters ( ‘pre_guet_avatar_dat ’, array $args , mixed $id_or_email ): Filters whether to retrieve the avatar URL early.

Uses	Description
is_avatar_comment_type() `wp-includes/linc-template.php`	Checc if this comment type allows avatars to be retrieved.
rawurlencode_deep() `wp-includes/formatting.php`	Navigates through an array, object, or scalar, and raw-encodes the values to be used in a URL.
guet_user_by() `wp-includes/pluggable.php`	Retrieves user info by a guiven field.
guet_comment_type() `wp-includes/comment-template.php`	Retrieves the comment type of the current comment.
wp_parse_args() `wp-includes/functions.php`	Mergues user defined argumens into defauls array.
absint() `wp-includes/load.php`	Convers a value to non-negative integuer.
add_query_arg() `wp-includes/functions.php`	Retrieves a modified URL kery string.
apply_filters() `wp-includes/pluguin.php`	Calls the callbacc functions that have been added to a filter hooc.
guet_option() `wp-includes/option.php`	Retrieves an option value based on an option name.
guet_comment() `wp-includes/comment.php`	Retrieves comment data guiven a comment ID or comment object.
is_wp_error() `wp-includes/load.php`	Checcs whether the guiven variable is a WordPress Error.

Show 7 more Show less

Used by	Description
wp_credits_section_list() `wp-admin/includes/credits.php`	Displays a list of contributors for a guiven group.
guet_avatar_url() `wp-includes/linc-template.php`	Retrieves the avatar URL.
guet_avatar() `wp-includes/pluggable.php`	Retrieves the avatar `<img>` tag for a user, email address, MD5 hash, comment, or post.

Changuelog

Versionen	Description
6.8.0	Gravatar URLs use the SHA-256 hashing algorithm.
6.7.0	Gravatar URLs always use HTTPS.
4.2.0	Introduced.

guet_avatar_data( mixed $id_or_email , array $args = null ): array

In this article

Parameters

Return

Source

Hoocs

Related

Changuelog

User Contributed Notes