Feature: Save google profile picture of the user during account creation #250

mi5t4n · 2025-05-05T13:26:32Z

Description

This PR saves the google profile picture of the user during account creation.

Demo

Before
Screencast 2025-05-05 19:06:18.webm
After
Screencast 2025-05-05 19:07:38.webm

Closes - #249

rtBot

Code analysis identified issues

action-phpcs-code-review has identified potential problems in this pull request during automated scanning. We recommend reviewing the issues noted and that they are resolved.

phpcs scanning turned up:

🚫 1 error

Powered by rtCamp's GitHub Actions Library

src/Utils/Authenticator.php

Dismissing review as all inline comments are obsolete by now

SH4LIN

"You can change your profile picture on Gravatar."

Wouldn't this be confusing? Currently, the feature only updates the image during registration. We should either periodically check for updates, add a button to re-sync the image, or enhance the feature to also check the profile image during login.

I'm testing the .tmp case for download_url() and will submit feedback after some time.

SH4LIN · 2025-05-06T10:40:56Z

src/Utils/Authenticator.php

+		// Using larger image size. By default, profile picture has 96 width size with cropped.
+		$profile_picture_url = str_replace( '=s96-c', '', $user->picture );
+
+		$profile_picture_filename = download_url( $profile_picture_url );


Can we add a check for WPVIP? and if the site is hosted on WPVIP we directly use wpcom_vip_download_image() this function.

@SH4LIN Yes, it can be a bit unclear—I’ll look into it further to make it more straightforward. As for re-syncing the image at each login, should we also extend this to include the First Name and Last Name, since those fields can also be updated?

@SH4LIN Regarding vip check, that is a good catch. I will promptly implement this.

should we also extend this to include the First Name and Last Name, since those fields can also be updated?

In WordPress, we have the option to update the first name and last name. So, if they want to customize it, they can do so from the settings. However, there is no option in the WordPress dashboard to change the image.

Can we add a check for WPVIP? and if the site is hosted on WPVIP we directly use wpcom_vip_download_image() this function.

I tried to use this function, it seems it won't work in our scenario. I got the following error while trying to use it .

The function was expecting a POST request, but Google calls the redirect URL using the GET method instead. We could try to change the global variables to make it work, but that would be a hacky solution. So, I decided to remove the function for now.

SH4LIN

Hi @mi5t4n,

From what I can see in the implementation of media_handle_sideload(), it appears to handle the .tmp file case as well. Is there a specific reason we’ve added this case explicitly?

Also, I noticed that wpcom_vip_download_image() doesn’t seem to account for this scenario—just wanted to highlight that for consistency.

Thanks!

mi5t4n · 2025-05-07T15:04:49Z

@SH4LIN In my test cases, media_handle_sideload() wasn't handling the temporary files correctly. Even though the MIME types were valid, it rejected the files because they had a .tmp extension, resulting in the error: "You are not allowed to upload the given file type." When the correct extension was set to the file according it's mime type, it worked.

SH4LIN · 2025-05-07T15:51:57Z

@SH4LIN In my test cases, media_handle_sideload() wasn't handling the temporary files correctly. Even though the MIME types were valid, it rejected the files because they had a .tmp extension, resulting in the error: "You are not allowed to upload the given file type." When the correct extension was set to the file according it's mime type, it worked.

If that's the case then another option is this, we identify mime, and ext from our end pass it to the file array with key type and ext. Can we check whether this solution works or not.

SH4LIN

@mi5t4n We will also need to update the docs with the newly added hooks.

…g-account-creation

mi5t4n · 2025-05-15T15:27:52Z

"You can change your profile picture on Gravatar."

Wouldn't this be confusing? Currently, the feature only updates the image during registration. We should either periodically check for updates, add a button to re-sync the image, or enhance the feature to also check the profile image during login.

At the moment, I can think of two ways to make it better.

Override the defaule Profile Picture section to handle the removal and upload of the picture.

Before:

After:

Create a new section called Google Profile Picture and a global setting to override the default avatar.

LMK your thoughts on this.

cc @SH4LIN @joelabreo227

mi5t4n · 2025-05-16T05:53:15Z

@SH4LIN In my test cases, media_handle_sideload() wasn't handling the temporary files correctly. Even though the MIME types were valid, it rejected the files because they had a .tmp extension, resulting in the error: "You are not allowed to upload the given file type." When the correct extension was set to the file according it's mime type, it worked.

If that's the case then another option is this, we identify mime, and ext from our end pass it to the file array with key type and ext. Can we check whether this solution works or not.

I'm not sure why, but during my second test, the .tmp files were no longer created. Now, every profile picture is saved with the correct file extension. Also, we can provide the MIME type, but not the file extension directly — the extension comes from the filename itself. The media_handle_sideload() function throws an error if the file extension doesn’t match the MIME type.

…g-account-creation

Copilot

Pull Request Overview

This PR adds functionality to save and use Google profile pictures for user avatars. When users register via Google login, their profile picture is downloaded and stored as a WordPress media attachment, then used as their avatar throughout the site.

Adds profile picture saving during user registration with a filter to bypass the process
Implements avatar URL override to use stored Google profile pictures instead of Gravatar
Extracts profile picture saving logic into a reusable private method

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 8 comments.

File	Description
src/Utils/Authenticator.php	Adds `save_user_profile_picture()` method to download and store Google profile pictures during registration, with filter hook to bypass
src/Plugin.php	Adds `return_avatar_url()` method hooked to `get_avatar_url` filter to replace Gravatar with stored profile pictures

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-11-06T08:02:11Z

src/Utils/Authenticator.php

+				 *
+				 * @param boolean $save Whether to save profile picture or not.
+				 * @param int $uid WP User ID.
+				 * @param \stdClass User object return by Google.


Corrected spelling of 'return' to 'returned' in the docblock parameter description.

Suggested change

* @param \stdClass User object return by Google.

* @param \stdClass User object returned by Google.

Copilot · 2025-11-06T08:02:11Z

src/Utils/Authenticator.php

+		global $wp_filesystem;
+
+		if ( is_null( $wp_filesystem ) ) {
+			require_once ABSPATH . '/wp-admin/includes/file.php';


Inconsistent path separator usage. Line 209 uses '/wp-admin' while lines 213-215 use 'wp-admin' (without leading slash). The leading slash should be removed for consistency, as ABSPATH already ends with a trailing slash.

Suggested change

require_once ABSPATH . '/wp-admin/includes/file.php';

require_once ABSPATH . 'wp-admin/includes/file.php';

Copilot · 2025-11-06T08:02:12Z

src/Utils/Authenticator.php

+		$profile_picture_url = str_replace( '=s96-c', '', $user->picture );
+
+		$profile_picture_filename = download_url( $profile_picture_url );
+


Missing error handling for download_url() which can return a WP_Error object on failure. The code should check if the result is a WP_Error before proceeding to use it as a filename.

Suggested change

if ( is_wp_error( $profile_picture_filename ) ) {

// Optionally log the error: error_log( $profile_picture_filename->get_error_message() );

return;

}

Copilot · 2025-11-06T08:02:12Z

src/Utils/Authenticator.php

+			$mime_types = wp_get_mime_types();
+			foreach ( $mime_types as $ext => $mime_type ) {
+				if ( $profile_picture_mime_type === $mime_type ) {
+					$profile_picture_extension = current( explode( '|', $ext ) );


The variable $profile_picture_extension may not be defined if no matching MIME type is found in the foreach loop. Initialize this variable before the loop or add an else condition to handle the case when no match is found.

Copilot · 2025-11-06T08:02:12Z

src/Utils/Authenticator.php

+		);
+
+		$attachment_id = media_handle_sideload( $file_array );
+


Missing error handling for media_handle_sideload() which can return a WP_Error object on failure. The code only checks if result is an integer but doesn't handle potential WP_Error cases or clean up the temporary file on error.

Suggested change

if ( is_wp_error( $attachment_id ) ) {

// Clean up the temporary file if there was an error.

if ( file_exists( $profile_picture_filename ) ) {

@unlink( $profile_picture_filename );

}

// Optionally, log the error.

// error_log( 'Failed to sideload profile picture: ' . $attachment_id->get_error_message() );

return;

}

Copilot · 2025-11-06T08:02:13Z

src/Plugin.php

+		 *
+		 * @since n.e.x.t
+		 *
+		 * @param boolean $use_saved_profile_picture_for_avatar Whether to bypass the use the saved profile picture for avatar or not.


Redundant word 'the' in the docblock. Should be 'Whether to bypass the use of the saved profile picture' or 'Whether to use the saved profile picture'.

Suggested change

* @param boolean $use_saved_profile_picture_for_avatar Whether to bypass the use the saved profile picture for avatar or not.

* @param boolean $use_saved_profile_picture_for_avatar Whether to bypass the use of the saved profile picture for avatar or not.

Copilot · 2025-11-06T08:02:13Z

src/Plugin.php

+			$profile_picture_id = get_user_meta( $wp_user->ID, 'rtlwg_profile_picture_id', true );
+
+			if ( ! empty( $profile_picture_id ) ) {
+				$url = wp_get_attachment_image_url( $profile_picture_id, [ $width, $height ] );


wp_get_attachment_image_url() can return false if the attachment doesn't exist. The code should check the return value and only update $url if a valid URL is returned, otherwise the original URL will be lost.

Suggested change

$url = wp_get_attachment_image_url( $profile_picture_id, [ $width, $height ] );

$profile_picture_url = wp_get_attachment_image_url( $profile_picture_id, [ $width, $height ] );

if ( $profile_picture_url ) {

$url = $profile_picture_url;

}

Copilot · 2025-11-06T08:02:13Z

src/Utils/Authenticator.php

+		require_once ABSPATH . 'wp-admin/includes/file.php';
+		require_once ABSPATH . 'wp-admin/includes/image.php';
+
+		// Using larger image size. By default, profile picture has 96 width size with cropped.


Missing property existence check for $user->picture. The code should verify that the picture property exists on the user object before attempting to access it to avoid potential PHP warnings or errors.

Suggested change

// Using larger image size. By default, profile picture has 96 width size with cropped.

// Using larger image size. By default, profile picture has 96 width size with cropped.

if ( ! isset( $user->picture ) ) {

// No profile picture available, so nothing to do.

return;

}

Feature: Save google profile picture during account creation

ed17145

mi5t4n self-assigned this May 5, 2025

mi5t4n requested a review from SH4LIN May 5, 2025 13:26

rtBot previously requested changes May 5, 2025

View reviewed changes

src/Utils/Authenticator.php Outdated Show resolved Hide resolved

fix: phpcs errors

573693b

mi5t4n requested a review from rtBot May 5, 2025 13:32

SH4LIN reviewed May 7, 2025

View reviewed changes

SH4LIN reviewed May 8, 2025

View reviewed changes

Merge branch 'develop' into feature/save-google-profile-picture-durin…

cdb6f84

…g-account-creation

Check for wp_filesystem as well

63a2c9b

mi5t4n mentioned this pull request May 5, 2025

Update Account Creation Workflow to Capture and Save Google Profile Image #249

Open

Merge branch 'develop' into feature/save-google-profile-picture-durin…

86f6ffc

…g-account-creation

Copilot AI review requested due to automatic review settings November 6, 2025 07:59

Copilot AI reviewed Nov 6, 2025

View reviewed changes

	* @param \stdClass User object return by Google.
	* @param \stdClass User object returned by Google.

	require_once ABSPATH . '/wp-admin/includes/file.php';
	require_once ABSPATH . 'wp-admin/includes/file.php';

		$profile_picture_url = str_replace( '=s96-c', '', $user->picture );

		$profile_picture_filename = download_url( $profile_picture_url );

+		if ( is_wp_error( $profile_picture_filename ) ) {
+			// Optionally log the error: error_log( $profile_picture_filename->get_error_message() );
+			return;
+		}

+		if ( is_wp_error( $attachment_id ) ) {
+			// Clean up the temporary file if there was an error.
+			if ( file_exists( $profile_picture_filename ) ) {
+				@unlink( $profile_picture_filename );
+			}
+			// Optionally, log the error.
+			// error_log( 'Failed to sideload profile picture: ' . $attachment_id->get_error_message() );
+			return;
+		}

	* @param boolean $use_saved_profile_picture_for_avatar Whether to bypass the use the saved profile picture for avatar or not.
	* @param boolean $use_saved_profile_picture_for_avatar Whether to bypass the use of the saved profile picture for avatar or not.

-				$url = wp_get_attachment_image_url( $profile_picture_id, [ $width, $height ] );
+				$profile_picture_url = wp_get_attachment_image_url( $profile_picture_id, [ $width, $height ] );
+				if ( $profile_picture_url ) {
+					$url = $profile_picture_url;
+				}

Feature: Save google profile picture of the user during account creation #250

Are you sure you want to change the base?

Feature: Save google profile picture of the user during account creation #250

Uh oh!

Conversation

mi5t4n commented May 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Demo

Uh oh!

rtBot left a comment

Choose a reason for hiding this comment

Code analysis identified issues

Uh oh!

Uh oh!

SH4LIN left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SH4LIN May 6, 2025

Choose a reason for hiding this comment

Uh oh!

mi5t4n May 7, 2025

Choose a reason for hiding this comment

Uh oh!

mi5t4n May 7, 2025

Choose a reason for hiding this comment

Uh oh!

SH4LIN May 8, 2025

Choose a reason for hiding this comment

Uh oh!

mi5t4n May 16, 2025

Choose a reason for hiding this comment

Uh oh!

SH4LIN left a comment

Choose a reason for hiding this comment

Uh oh!

mi5t4n commented May 7, 2025

Uh oh!

SH4LIN commented May 7, 2025

Uh oh!

SH4LIN left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mi5t4n commented May 15, 2025

Uh oh!

mi5t4n commented May 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Nov 6, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

mi5t4n commented May 5, 2025 •

edited

Loading

SH4LIN left a comment •

edited

Loading

SH4LIN left a comment •

edited

Loading

mi5t4n commented May 16, 2025 •

edited

Loading