Fix/135 Re-adding "Square" Crop ability

[faisal-alvi]

Description of the Change

• This PR removes the "freeform" ability and re-adds the "sure" crop ability (which was removed in Enhancement/128 ”Skip cropping” + “Free cropping area” added! #130).
• Also updates the button name from "Skip Crop" to "Default Crop" only on the edit profile page.

Closes #135

Alternate Designs

n/a

Possible Drawbacks

Maybe in the future, we get some users wanting the freeform crop ability.

Verification Process

1. Edit your profile.
2. Set an avatar.
3. See, you are forced to stick with the Square form while cropping an avatar.
4. Also check if the button name from "Skip Crop" to "Default Crop" is only changed on the edit profile page, not any other page like when selecting the site icon in the customizer (wp-admin/customize.php?return=%2Fwp-admin%2Fprofile.php), the button name should be "Skip Crop".

Checklist:

• I have read the CONTRIBUTING document.
• My code follows the code style of this project.
• My change requires a change to the documentation.
• I have updated the documentation accordingly.
• I have added tests to cover my change.
• All new and existing tests passed.

Changelog Entry

Added - Re-added the Square crop ability.

Credits

Props @dkotter @dinhtungdu @faisal-alvi

[peterwilsoncc]

LGTM.

The skip cropping button remains in place (which actually uses the default square crop during testing), was that intentional? I am presuming it is and approving the change for now.

[faisal-alvi]

@peterwilsoncc Thanks for raising this point, this seems similar mentioned by @dinhtungdu in #131 (comment). Even if a user skips the crop, the end result will still be in the (default) square.

WordPress displays an avatar in its appropriate/nearest scaled size at FE, we are also using the same avatar size that is found in the arguments passed to get_avatar_data() and displaying our Simple Local Avatar (regardless of the avatar was skipped for crop or not).

simple-local-avatars/includes/class-simple-local-avatars.php

Line 256 in a6d3af8

$simple_local_avatar_url = $this->get_simple_local_avatar_url( $id_or_email, $args['size'] );

If a user crops avatar, a cropped image's scaled version is displayed at FE "vs", If cropping is skipped, the original image's scaled version is displayed. In either case, the scaled (or we can say "cropped") image is displayed at FE. This is WP's default behavior.

Now the question is - are we supposed to display an 'original' size avatar when the user clicks "Skip Cropping"? In that case, we have to add a new user meta that stores whether the avatar is cropped or not. And conditionally skip passing the size in the above code and use something like this:

$simple_local_avatar_url = $this->get_simple_local_avatar_url( $id_or_email, 0 ); (where 0 will bring the original image URL)

I have uploaded and set a 460 x 6358 (vertical) avatar image and used the 'original' version (by using the above code statically), and here are the results.

IMO, we should not change the WP's default behavior of displaying avatars at the front end (by displaying 'original' sized avatars) and keep using the "default" crop/scaled version of Avatar. However, I'm concerned users may get confused about why the avatar is in default cropped mode even if they have clicked "Skip Crop".

@dkotter @jeffpaul - please share your thoughts, is it fine to keep using the scaled avatar images by WordPress at the front end (even when the user chooses the "Skip cropping" while setting up an avatar in the backend?

[peterwilsoncc]

IMO, we should not change the WP's default behavior of displaying avatars at the front end (by displaying 'original' sized avatars) and keep using the "default" crop/scaled version of Avatar. However, I'm concerned users may get confused about why the avatar is in default cropped mode even if they have clicked "Skip Crop".

This makes sense.

How about instead of "Skip Crop" the text is changed to "Default Crop". This can be discussed on another ticket as this PR covers a different change.

[faisal-alvi]

@peterwilsoncc the "Skip Crop" is coming from the core and I didn't find a way to overwrite it.

https://github.com/WordPress/WordPress/blob/9e3dc52d45f6023df554ab421f9daf34f2383444/wp-includes/media.php#L4600

EDIT: Found the filter media_view_strings just below that code to modify the strings.

[peterwilsoncc]

Looks good, thanks.