WordPress添加自定义头像上传功能

WordPress 默认支持 Gravatar 头像，然而国内用户使用的比较少（网络的一些原因，该头像服务加载可能比较困难。）WordPress 默认又没有提供头像上功能，对于一些开启了用户中心的网站，这样显然不太友好。网上解决这个问题，一般是通过 Simple Local Avatars 或者 WP User Avatar 等插件来实现的，一些传说中纯代码的方案也是直接引入 Simple Local Avatars 插件中的单文件。

文件的上传主要使用了 media_handle_upload()

新建 fun_local_avatar.php 文件

所有内容都写在一个文件了，具体内容如下：

1. <?php
3. function _edit_user_avatar_profile($user){
4. $avatar = get_user_meta($user->ID, 'avatar', true);
5. $user_cap = current_user_can( 'upload_files' ) ? 'YES' : 'NO';
6. $avatar_default = $avatar ? $avatar : get_template_directory_uri().'/img/avatar-default.png';
7. ?>
8. <h2>用户头像</h2>
9. <table class="form-table" cellspacing="0">
10. <tbody>
11. <tr id="user_avatar" class="user-avatar" valign="center">
12. <th scope="row"><label for="avatar">自定义头像</label></th>
13. <td class="user-avatar-img">
14. <img id="user-avatar-new" src="<?php echo $avatar_default; ?>" alt="本地头像"/>
15. </td>
16. <td class="user-avatar-wrap">
17. <input type="hidden" name="avatar" id="avatar" class="regular-text" value="<?php echo $avatar; ?>">
18. <?php if ( current_user_can( 'upload_files' ) ) { ?>
19. <!-- 有 upload_files 权限媒体库选择图片文件 -->
20. <span class="desc">在媒体库中选择一个图片作为头像：</span>
21. <div class="user-avatar-btn wp-media-buttons">
22. <div data-user_cap="<?php echo $user_cap; ?>" data-item_type="url" class="media-library-upload button add_media">添加图片</div>
23. </div>
24. <?php } ?>
25. <!-- 无 upload_files 权限计算机上传图片文件 -->
26. <span class="desc">从计算机中上传一张图片作为头像：</span><br />
27. <div class="user-avatar-btn wp-media-buttons">
28. <input type="file" name="local-avatar-upload" id="local-avatar-upload" class="local-avatar-upload" />
29. <?php wp_nonce_field( 'local-avatar-upload', 'local-avatar-upload_nonce' ); ?>
30. </div>
31. </td>
32. </tr>
33. </tbody>
34. </table>
35. <?php
36. }
37. add_action('show_user_profile', '_edit_user_avatar_profile', 1);
38. add_action('edit_user_profile', '_edit_user_avatar_profile', 1);
40. // 媒体库选择文件更新 avatar 值(用户有 upload_files 权限)
41. function _edit_user_avatar_profile_update($user_id){
42. if(current_user_can('edit_users') || get_current_user_id() == $user_id){
43. $avatar = $_POST['avatar'] ? : '';
44. if($avatar){
45. update_user_meta($user_id, 'avatar', $avatar);
46. }else{
47. delete_user_meta($user_id, 'avatar');
48. }
49. }
50. }
51. add_action('personal_options_update','_edit_user_avatar_profile_update');
52. add_action('edit_user_profile_update','_edit_user_avatar_profile_update');
54. // 用户上传文件更新 avatar (用户无 upload_files 权限)
55. function _upload_user_avatar_profile_update($user_id){
56. $user_id = get_current_user_id();
57. // check nonces
58. if( empty( $_POST['local-avatar-upload_nonce'] ) || ! wp_verify_nonce( $_POST['local-avatar-upload_nonce'], 'local-avatar-upload' ) ){
59. return;
60. }
61. // 判断 media_handle_upload() 是否存在
62. if ( ! function_exists( 'media_handle_upload' ) ){
63. require_once( ABSPATH . 'wp-admin/includes/media.php' );
64. }
66. // 自定义头像上传路径（ Upload 文件夹下的路径 ）
67. function avatar_upload_dir( $dir ) {
68. $sub_dir = get_currentuserinfo()->ID;
69. return array(
70. 'path' => $dir['basedir'] . '/avatars/' . $sub_dir,
71. 'url' => $dir['baseurl'] . '/avatars/' . $sub_dir,
72. 'subdir' => '/avatars/' . $sub_dir,
73. ) + $dir;
74. }
76. add_filter( 'upload_dir', 'avatar_upload_dir');
78. $avatar_id = media_handle_upload( 'local-avatar-upload', 0, array(), array(
79. 'mimes' => array(
80. 'jpg|jpeg|jpe' => 'image/jpeg',
81. 'gif' => 'image/gif',
82. 'png' => 'image/png',
83. ),
84. 'test_form' => false
85. ));
87. remove_filter( 'upload_dir', 'avatar_upload_dir' );
89. if(!is_numeric($avatar_id)){ return; } // 未上传文件的话直接返回
90. if ( is_wp_error( $avatar_id ) ) { //
91. // 图片上传错误处理信息
92. function user_avatar_upload_errors( WP_Error $errors ) {
93. $error_message = function_exists('get_error_message') ? $avatar_id->get_error_message() : "未知错误，请仔细检查文件！";
94. $avatar_upload_error = '<strong>' . __( 'Avatar 头像上传错误:'.gettype($avatar_id) , 'local-avatar-upload' ) . '</strong> ' . esc_html( $error_message );
95. $errors->add( 'avatar_error', $avatar_upload_error );
96. }
97. add_action( 'user_profile_update_errors', 'user_avatar_upload_errors' );
99. return;
100. }else{
101. $avatar_url = wp_get_attachment_image_src( $avatar_id, 'full')[0];
102. update_user_meta($user_id, 'avatar', $avatar_url);
103. }
104. }
105. add_action( 'personal_options_update', '_upload_user_avatar_profile_update' );
106. add_action( 'edit_user_profile_update', '_upload_user_avatar_profile_update' );
108. // 确保配置文件表单具有正确的编码类型, 一般默认的 enctype="application/x-www-form-urlencoded";不能用于上传文件
109. function user_edit_form_tag() {
110. echo 'enctype="multipart/form-data"';
111. }
112. add_action( 'user_edit_form_tag', 'user_edit_form_tag' );
114. // 用户有上传权限调用 wp.media 库
115. function admin_enqueue_scripts(){
116. if ( current_user_can( 'upload_files' ) ){
117. wp_enqueue_media();
118. }
119. }
120. add_action('admin_enqueue_scripts', 'admin_enqueue_scripts');
122. add_action('admin_footer', function(){
123. ?>
124. <style type="text/css">
125. .form-table .user-avatar-img{
126. display: inline-block;
127. width: 120px;
128. height: 120px;
129. margin: 0;
130. padding: 0;
131. border: 1px solid #999;
132. border-radius: 9px;
133. overflow: hidden;
134. }
135. .form-table .user-avatar-img img{
136. width: 100%;
137. height: 100%;
138. }
139. .form-table .user-avatar-wrap {
140. display: inline-block;
141. width: auto;
142. height: 110px;
143. margin: 0;
144. padding: 5px 20px;
145. border: 0;
146. }
147. .form-table .user-avatar-wrap .user-avatar-btn{
148. width: 80px;
149. margin: 5px 0;
150. padding: 0;
151. border: 0;
152. font-size: 14px;
153. }
154. </style>
156. <script>
157. (function($){
158. // 有 upload_files 权限媒体库选择图片文件
159. $('body').on('click', '.media-library-upload', function(e) {
160. // 阻止事件默认行为
161. e.preventDefault();
163. var user_cap = $(this).data('user_cap');
164. if (user_cap=="NO"){alert("抱歉，你没有上传图片的权限！")}
165. var item_type = $(this).data('item_type');
166. var input_tag = $('#avatar');
167. var img_tag = $('#user-avatar-new');
169. //唤起 WordPress 默认媒体上传
170. custom_uploader = wp.media.frames.local_avatar_frame = wp.media({
171. title: '选择图片',
172. library: { type: 'image' },
173. button: { text: '选择图片' },
174. multiple: false
175. });
177. wp.media.frames.local_avatar_frame.on('select', function() {
178. var attachment = wp.media.frames.local_avatar_frame.state().get('selection').first().toJSON();
179. var img_value = (item_type == 'url') ? attachment.url : attachment.id;
181. // 将图像路径赋值给 input 的 value
182. input_tag.val(img_value);
183. img_tag.attr('src', img_value);
185. });
187. wp.media.frames.local_avatar_frame.open();
189. });
191. // 无 upload_files 权限本地上传图片文件
192. $('body').on('change', '.local-avatar-upload', function(e) {
193. var file = this.files[0];
194. // 限制文件类型
195. var fileType = /^image\//;
196. if ( !fileType.test(file.type) ) {
197. alert("请选择一张图片！");
198. $(this).val('')
199. return;
200. }
201. //限制文件大小
202. var imgSize = file.size;
203. if(imgSize> 200*1024){
204. alert('上传的图片不得大于200KB！');
205. $(this).val('')
206. return false;
207. }
208. // 预览图片
209. filePath = URL.createObjectURL(file);
210. $('#user-avatar-new').attr('src', filePath);
211. });
212. })(jQuery)
214. </script>
215. <?php
216. });

代码中基本上都做了注释了，方便大家理解，有需要的小伙伴可以在此基础上做些修改。

引入 fun_local_avatar.php

将代码丢到主题目录下，然后在主题 functions.php 中直接引入即可，引入代码如下，注意修改路径！

1. // 后台自定义上传头像
2. require get_template_directory() . '/functions/fun_local_avatar.php';

以上。