Looking For Something?

[wps-avatar-change]

Purpose

Displays the form to let users upload an avatar.

Via WPS Pro->Setup->Profile Page you should, and hopefully have, set the page that you are using to allow users to upload, and crop, an avatar. Cropping is always skipped on mobile devices.

This shortcode should be used on that page, which prompts the user to upload an image, and then allows them to (optionally) crop the image.

Screenshot_6The avatar upload process is in three steps.

  1. The user uploads an image
  2. The user can select an area of the image (crop)
  3. The user saves the selected area

Note that the cropping step is skipped if using a mobile device.

To preserve the overall style of WP Symposium Pro, the selected area must be a square, with the preview shown whilst the area is selected.

As an example, the avatar being used here, is selected from a larger image, with the preview shown beside the “Crop” button:

Note also, that user meta “wps_pro_avatar” is updated with the avatar path when uploading a custom avatar. If you want to use this database user meta value, you should run “WPS Pro->Setup->System Options->Re-sync avatar meta” (checkbox) at least once to update existing users who have uploaded avatars (otherwise not necessary). You can then, for example, use database queries to get a list of all users that have (or have not) uploaded an avatar.

Once an image has been uploaded, if enabled, users have the facility to rotate and alter the appearance of the image.

These options appear above the uploaded image (after uploading).

Availability

Provided in the Core Plugin.

Customising

You can use the global shortcode settings via WPS Pro->Shortcodes in the admin dashboard, or add them to the shortcode as options.

Example

The example is using a French word, perhaps for a French speaking site.

[wps-avatar-change label="Télécharger"]

Options

The following (which shows default values and an example of using the shortcode option) can be set via the admin dashboard (WPS Pro->Shortcodes) or added as options to the shortcode in your WordPress page, post or widget.

Prompt for step 1   (step1=”Step 1: Click on this link to choose an image and afterwards click the button below.”)
Prompt for step 2   (step2=”Step 2: First select an area on your uploaded image, and then click the crop button.”)
Label for Upload button   (label=”Upload”)
Text for link to choose an image   (choose=”Click here to choose an image… (maximum %dKB)”)
Try again message   (try_again_msg=”Try again…”)
Allowed file types   (file_types_msg=”Please upload an image file (.jpeg, .gif, .png).”)
Not allowed to change avatar message   (not_permitted=”You are not allowed to change this avatar.”)
File too big message   (file_too_big_msg=”Please upload an image file no larger than %dKB, yours was %dKB.”)
Maximum file upload size (KB)   (max_file_size=”500″)
Allow users to crop avatars   (crop=”1″)
Activate special effects   (effects=”0″)
Label for Flip   (flip=”Flip”)
Label for Rotate   (rotate=”Rotate”)
Label for Invert   (invert=”Invert”)
Label for Sketch   (sketch=”Sketch”)
Label for Pixelate   (pixelate=”Pixelate”)
Label for Sepia   (sepia=”Sepia”)
Label for Emboss   (emboss=”Emboss”)
Must be logged in message   (logged_out_msg=”You must be logged in to view this page.”)
Optional URL to login   (login_url=””)
Sidebar