wp-user-avatar
Last commit date
css
13 years ago
images
13 years ago
js
13 years ago
index.html
13 years ago
readme.txt
13 years ago
wp-user-avatar.php
13 years ago
readme.txt
231 lines
| 1 | === WP User Avatar === |
| 2 | |
| 3 | Contributors: bangbay |
| 4 | Donate link: http://siboliban.org/donate |
| 5 | Tags: author image, author photo, author avatar, avatar, profile avatar, profile image, profile photo, user avatar, user image, user photo |
| 6 | Requires at least: 3.3 |
| 7 | Tested up to: 3.5.1 |
| 8 | Stable tag: 1.2 |
| 9 | License: GPLv2 or later |
| 10 | License URI: http://www.gnu.org/licenses/gpl-2.0.html |
| 11 | |
| 12 | Use any image from your WordPress Media Library as a custom user avatar. Add your own Default Avatar. |
| 13 | |
| 14 | == Description == |
| 15 | |
| 16 | WordPress currently only allows you to use custom avatars that are uploaded through [gravatar.com](http://gravatar.com/). WP User Avatar enables you to use any photo uploaded into your Media Library as an avatar. This means you use the same uploader and library as your posts. No extra folders or image editing functions are necessary. |
| 17 | |
| 18 | To use WP User Avatar, choose a theme that has avatar support. In your theme, manually replace <code>get_avatar</code> with <code>get_wp_user_avatar</code> or leave <code>get_avatar</code> as-is. <code>get_wp_user_avatar</code> has functionality not available in <code>get_avatar</code>. [Read about the differences here](http://wordpress.org/extend/plugins/wp-user-avatar/faq/). |
| 19 | |
| 20 | WP User Avatar also lets you: |
| 21 | |
| 22 | * Upload your own Default Avatar in your Discussion settings. |
| 23 | * Show the user's gravatar.com avatar or Default Avatar if the user doesn't have a WP User Avatar image. |
| 24 | * Use the shortcode <code>[avatar]</code> in your posts. The shortcode will work with any theme, whether it has avatar support or not. |
| 25 | |
| 26 | [Read more about get_avatar in the WordPress Function Reference](http://codex.wordpress.org/Function_Reference/get_avatar). |
| 27 | |
| 28 | This plugin uses the Media uploader introduced in WordPress 3.5, but is also backwards-compatible to WordPress 3.3. |
| 29 | |
| 30 | == Installation == |
| 31 | |
| 32 | 1. Download, install, and activate the WP User Avatar plugin. |
| 33 | 2. On your edit profile page, click "Edit WP User Avatar". |
| 34 | 3. Choose an image, then click "Set WP User Avatar". |
| 35 | 4. Click "Update Profile". |
| 36 | 5. Upload your own Default Avatar in your Discussion settings (optional). |
| 37 | 6. Choose a theme that has avatar support. In your theme, manually replace <code>get_avatar</code> with <code>get_wp_user_avatar</code> or leave <code>get_avatar</code> as-is. [Read about the differences here](http://wordpress.org/extend/plugins/wp-user-avatar/faq/). |
| 38 | 7. You can also use the shortcode <code>[avatar]</code> in your posts. The shortcode will work with any theme, whether it has avatar support or not. |
| 39 | |
| 40 | **Example Usage** |
| 41 | |
| 42 | Within The Loop, you may be using: |
| 43 | |
| 44 | `<?php echo get_avatar(get_the_author_meta('ID'), 96); ?>` |
| 45 | |
| 46 | Replace this function with: |
| 47 | |
| 48 | `<?php echo get_wp_user_avatar(get_the_author_meta('ID'), 96); ?>` |
| 49 | |
| 50 | You can also use the values "original", "large", "medium", or "thumbnail" for your avatar size: |
| 51 | |
| 52 | `<?php echo get_wp_user_avatar(get_the_author_meta('ID'), 'medium'); ?>` |
| 53 | |
| 54 | You can also add an alignment of "left", "right", or "center": |
| 55 | |
| 56 | `<?php echo get_wp_user_avatar(get_the_author_meta('ID'), 96, 'left'); ?>` |
| 57 | |
| 58 | On an author page outside of The Loop, you may be using: |
| 59 | |
| 60 | `<?php |
| 61 | $user = get_user_by('slug', $author_name); |
| 62 | echo get_avatar($user->ID, 96); |
| 63 | ?>` |
| 64 | |
| 65 | Replace this function with: |
| 66 | |
| 67 | `<?php |
| 68 | $user = get_user_by('slug', $author_name); |
| 69 | echo get_wp_user_avatar($user->ID, 96); |
| 70 | ?>` |
| 71 | |
| 72 | If you leave the options blank, WP User Avatar will detect whether you're inside The Loop or on an author page and return the correct avatar in the default 96x96 size: |
| 73 | |
| 74 | `<?php echo get_wp_user_avatar(); ?>` |
| 75 | |
| 76 | The function <code>get_wp_user_avatar</code> will also fall back to <code>get_avatar</code> if no WP User Avatar image is set. For this to work, "Show Avatars" must be checked in your Discussion settings. When this setting is enabled, you will see the user's gravatar.com avatar or Default Avatar. |
| 77 | |
| 78 | **Other Available Functions** |
| 79 | |
| 80 | = [avatar] shortcode = |
| 81 | |
| 82 | You can use the shortcode <code>[avatar]</code> in your posts. It will detect the author of the post or you can specify an author by username. You can specify a size and alignment, but they are optional. |
| 83 | |
| 84 | `[avatar user="admin" size="medium" align="left"]` |
| 85 | |
| 86 | = get_wp_user_avatar_src = |
| 87 | |
| 88 | Works just like <code>get_wp_user_avatar</code> but returns just the image src. This is useful if you would like to link a thumbnail-sized avatar to a larger version of the image: |
| 89 | |
| 90 | `<a href="<?php echo get_wp_user_avatar_src($user_id, 'large'); ?>"> |
| 91 | <?php echo get_wp_user_avatar($user_id, 'thumbnail'); ?> |
| 92 | </a>` |
| 93 | |
| 94 | = has_wp_user_avatar = |
| 95 | |
| 96 | Returns true if the user has a WP User Avatar image. You can specify the user ID, or leave it blank to detect the author within The Loop or author page: |
| 97 | |
| 98 | `<?php |
| 99 | if ( has_wp_user_avatar($user_id) ) { |
| 100 | echo get_wp_user_avatar($user_id, 96); |
| 101 | } else { |
| 102 | echo '<img src="my-alternate-image.jpg" />'; |
| 103 | } |
| 104 | ?>` |
| 105 | |
| 106 | == Frequently Asked Questions == |
| 107 | |
| 108 | = How do I use WP User Avatar? = |
| 109 | |
| 110 | First, choose a theme that has avatar support. In your theme, you have a choice of manually replacing <code>get_avatar</code> with <code>get_wp_user_avatar</code>, or leaving <code>get_avatar</code> as-is. Here are the differences: |
| 111 | |
| 112 | = get_wp_user_avatar = |
| 113 | |
| 114 | 1. Allows you to use the values "original", "large", "medium", or "thumbnail" for your avatar size. |
| 115 | 2. Doesn't add a fixed width and height to the image if you use the aforementioned values. This will give you more flexibility to resize the image with CSS. |
| 116 | 3. Optionally adds CSS classes "alignleft", "alignright", or "aligncenter" to position your avatar. |
| 117 | 4. Shows nothing if the user has no WP User Avatar image. |
| 118 | 5. Shows the user's gravatar.com avatar or the Default Avatar only if "Show Avatars" is enabled in your Discussion settings. |
| 119 | |
| 120 | = get_avatar = |
| 121 | |
| 122 | 1. Requires you to enable "Show Avatars" in your Discussion settings to show any avatars. |
| 123 | 2. Accepts only numeric values for your avatar size. |
| 124 | 3. Always adds a fixed width and height to your image. This may cause problems if you use responsive CSS in your theme. |
| 125 | 4. Show the user's gravatar.com avatar or the Default Avatar if the user doesn't have a WP User Avatar image. (Choosing "Blank" as your Default Avatar still generates a transparent image file.) |
| 126 | 5. Requires no changes to your theme files if you are currently using <code>get_avatar</code>. |
| 127 | |
| 128 | = Can I create a custom Default Avatar? = |
| 129 | In your Discussion settings, you can upload your own Default Avatar. |
| 130 | |
| 131 | = Can I insert WP User Avatar directly into a post? = |
| 132 | |
| 133 | You can use the shortcode <code>[avatar]</code> in your posts. The shortcode will work with any theme, whether it has avatar support or not. It will detect the author of the post or you can specify an author by username. You can specify a size or alignment, but they are optional. |
| 134 | |
| 135 | `[avatar user="admin" size="medium" align="left"]` |
| 136 | |
| 137 | = Will WP User Avatar work with comment author avatars? = |
| 138 | |
| 139 | Yes, for registered users. Non-registered comment authors will show their gravatar.com avatars. |
| 140 | |
| 141 | = How can I see which users have an avatar? = |
| 142 | |
| 143 | For administrators, WP User Avatar adds a column with avatar thumbnails to your Users admin table. If "Show Avatars" is enabled in your Discussion settings, you will see avatars to the left of each username instead of in a new column. |
| 144 | |
| 145 | = What CSS can I use with WP User Avatar? = |
| 146 | |
| 147 | WP User Avatar will add the CSS classes "wp-user-avatar" and "wp-user-avatar-{size}" to your image. If you add an alignment, the corresponding alignment class will be added: |
| 148 | |
| 149 | `<?php echo get_wp_user_avatar($user_id, 96, 'left'); ?>` |
| 150 | |
| 151 | Outputs: |
| 152 | |
| 153 | `<img src="{imageURL}" width="96" height="96" class="wp-user-avatar wp-user-avatar-96 alignleft" />` |
| 154 | |
| 155 | If you use the values "original", "large", "medium", or "thumbnail", no width or height will be added to the image. This will give you more flexibility to resize the image with CSS: |
| 156 | |
| 157 | `<?php echo get_wp_user_avatar($user_id, 'medium'); ?>` |
| 158 | |
| 159 | Outputs: |
| 160 | |
| 161 | `<img src="{imageURL}" class="wp-user-avatar wp-user-avatar-medium" />` |
| 162 | |
| 163 | **Note:** WordPress adds more CSS classes to the avatar not listed here. |
| 164 | |
| 165 | = What other functions are available for WP User Avatar? = |
| 166 | * <code>get_wp_user_avatar_src</code> - retrieve just the image URL |
| 167 | * <code>has_wp_user_avatar</code> - check if the user has a WP User Avatar image |
| 168 | |
| 169 | [See example usage here](http://wordpress.org/extend/plugins/wp-user-avatar/installation/) |
| 170 | |
| 171 | == Screenshots == |
| 172 | |
| 173 | 1. WP User Avatar lets you upload your own Default Avatar. |
| 174 | 2. WP User Avatar adds a field to your profile in edit mode. |
| 175 | 3. After you've set a WP User Avatar image, you will see the option to remove it. |
| 176 | |
| 177 | == Changelog == |
| 178 | |
| 179 | = 1.2 = |
| 180 | * Add: Default Avatar setting |
| 181 | |
| 182 | = 1.1.7 = |
| 183 | * Bug Fix: Change update_usermeta to update_user_meta |
| 184 | |
| 185 | = 1.1.6 = |
| 186 | * Bug Fix: Image not showing in user profile edit |
| 187 | |
| 188 | = 1.1.5a = |
| 189 | * Update: readme.txt |
| 190 | |
| 191 | = 1.1.5 = |
| 192 | * Bug Fix: Remove stray curly bracket |
| 193 | |
| 194 | = 1.1.4 = |
| 195 | * Bug Fix: Change get_usermeta to get_user_meta |
| 196 | * Bug Fix: Non-object warning when retrieving user ID |
| 197 | |
| 198 | = 1.1.3 = |
| 199 | * Bug Fix: Comment author with no e-mail address |
| 200 | |
| 201 | = 1.1.2 = |
| 202 | * Remove: Unused variables |
| 203 | |
| 204 | = 1.1.1 = |
| 205 | * Bug Fix: Capabilities error in comment avatar |
| 206 | |
| 207 | = 1.1 = |
| 208 | * Add: Add filter for get_avatar |
| 209 | * Add: CSS alignment classes |
| 210 | * Add: Replace comment author avatar |
| 211 | * Add: Shortcode |
| 212 | * Update: readme.txt |
| 213 | |
| 214 | = 1.0.2 = |
| 215 | * Update: FAQ |
| 216 | * Remove: CSS that hides "Insert into Post" |
| 217 | |
| 218 | = 1.0.1 = |
| 219 | * Add: CSS classes to image output |
| 220 | |
| 221 | = 1.0 = |
| 222 | * Initial release |
| 223 | |
| 224 | == Upgrade Notice == |
| 225 | |
| 226 | = 1.2= |
| 227 | * New Feature: Default Avatar customization |
| 228 | |
| 229 | = 1.1 = |
| 230 | * New Features: [avatar] shortcode, direct replacement of get_avatar() and comment author avatar, more CSS classes |
| 231 |