Settings saved successfully.
132 |
133 |
197 |
198 |
2 |
3 |
4 |
278 |
279 |
291 |
292 |
293 | AJAX file upload Documentation
134 | 135 | 195 | 196 |
294 |
302 | 295 | afu 296 | font demo 297 |
298 | 301 |
303 |
310 |
311 |
312 |
--------------------------------------------------------------------------------
/assets/js/main.js:
--------------------------------------------------------------------------------
1 | /**
2 | * Did you know? you can modify this by copying the entire plugin folder (ajax-upload-file/)
3 | * into your child theme, and from there you can edit any file except the core files ( for
4 | * core files, any changes made in your child theme won't be applicable )
5 | *
6 | * @since 0.1
7 | * @author Samuel Elh
304 |
305 |
306 |
307 |
308 |
309 |
2 |
3 | 
A small preview WpChats 3.0 profile edit
8 |
9 |
189 |
--------------------------------------------------------------------------------
/includes/afu-about.php:
--------------------------------------------------------------------------------
1 | '',
5 | 'max_size' => '',
6 | 'allowed_extensions' => '',
7 | 'permissions' => '',
8 | 'on_success_alert' => '',
9 | 'on_fail_alert' => '',
10 | 'on_fail_alert_error_message' => '',
11 | 'on_success_set_input_value' => '',
12 | 'set_background_image' => '',
13 | 'set_image_source' => '',
14 | 'disallow_remove_button' => '',
15 | 'disallow_reupload' => '',
16 | 'upload_button_value' => '',
17 | 'select_file_button_value' => '',
18 | 'remove_file_button_value' => '',
19 | 'show_preloader' => '',
20 | 'default_loading_text' => '',
21 | 'on_success_dialog_prompt_value' => '',
22 | );
23 |
24 | ?>
25 |
26 | Welcome to AJAX File Upload v. 0.1!
4 | 5 |Thank you for using AJAX File Upload to quickly process your uploads on the go!
6 | 7 | A small preview WpChats 3.0 profile edit This plugin will help you add file upload feature to your site, set maximum upload size, allowed file extensions, and much more through a simple shortcode or a custom function.
10 | 11 |Totally AJAX, your uploads will be processed faster and an elegant way. All you need to do is to add the shortcode to your content, or call the plugin's custom function whithin your code and that's it.
12 | 13 |The Shortcode
14 | 15 |You can use [ajax-file-upload] to output the AJAX file uploader, set its settings, markup, and much more through the shortcode attributes.
Shortcode attributes
18 | 19 |
20 |
21 |
43 |
44 | -
22 |
unique_identifier
23 | max_size
24 | allowed_extensions
25 | permissions
26 | on_success_alert
27 | on_fail_alert
28 | on_fail_alert_error_message
29 | on_success_set_input_value
30 | set_background_image
31 | set_image_source
32 | disallow_remove_button
33 | disallow_reupload
34 | upload_button_value
35 | select_file_button_value
36 | remove_file_button_value
37 | show_preloader
38 | default_loading_text
39 | on_success_dialog_prompt_value
40 |
45 |
46 |
101 |
102 | 1. unique_identifier — required
47 |This is a required attribute. Insert anything random that makes the uploader unique, used to store the uploader settings in the database and get them while processing a file for the shortcode in use.
Example use: unique_identifier="my_contact_form"
2. max_size — optional
50 |Allows you to set the maximum file size to upload in KB. 1 MB is equal to 1000 KB.
Example use: max_size=3000 for 3 MB upload
3. allowed_extensions — optional
53 |With this attribute you can set the allowed file extensions to upload. Please separate the extensions with commas.
Example use: allowed_extensions="pdf,txt"
4. permissions — optional
56 |Set the required permission for a user to upload a file. You can set all for all users (even logged-out ones), or logged_in for logged-in users only, or a custom user role e.g author. If you choose to set a role, the current user is required to have that role in order to process an upload.
5. on_success_alert — optional
59 |Alert the user that their upload is done. You can set custom messages to output within the dialog. It is optional, and no default alert is there if you don't set this attribute.
Example use: on_success_alert="Your file was successfully uploaded"
6. on_fail_alert — optional
62 |When a file is not processed successfully, you can use this attribute to alert the user with a custom message.
Example use: on_fail_alert="We couldn't have your file uploaded. Try again?"
7. on_fail_alert_error_message — optional
65 |An error message is always included in the AJAX response while a file was not processed with success. To alert this message to the user, you just need to add this attribute with some value that makes it true.
Example use: on_fail_alert_error_message="true"
8. on_success_set_input_value — optional
68 |You might have a hidden or visible input within your form where you want to put the uploaded media URL. If so, then use this attribute and put that field selector as the attribute value. If this field was not found in the DOM, an error will be added to the console.
Example use: on_success_set_input_value="#my_hidden_input"
9. set_background_image — optional
71 |When uploading an image, you probably want to use this attribute to set an element's background-image property with the returned image upload URL. The value has to be a valid element selector.
Example use: set_background_image=".cover-photo-container"
10. set_image_source — optional
74 |Same here, when uploading an image you would probably want to set an image source attribute with the returned image upload URL. If so then provide this image selector in the DOM.
Example use: set_image_source="img.profile-pic"
11. disallow_remove_button — optional
77 |This attribute allows you to not provide a file delete button with the shortcode output. It can be handy when you don't want a user to multiple files everytime as they hit this button. Set its value and the button won't be there.
Example use: disallow_remove_button="1"
12. disallow_reupload — optional
80 |This can be handy to prevent users to upload multiple files. Set its value to something that makes it true, as you do, when a user uploads a file, the upload and remove button will both disappear, and the select one will become disabled.
Example use: disallow_reupload=""
13 upload_button_value — optional
83 |The default value is "upload" and translatable through the admin settings. Lets you edit the upload button text.
Example use: upload_button_value="upload file"
14. select_file_button_value — optional
86 |The default value is "choose file" and translatable through the admin settings. Lets you edit the select button text..
Example use: select_file_button_value="choisir un fichier"
15. remove_file_button_value — optional
89 |The default value is "remove" and translatable through the admin settings. Lets you edit the remove button text..
Example use: remove_file_button_value="click to remove this file"
16. show_preloader — optional
92 |If you have a hidden preloader which you want to show while the upload is being processed, provide its selector in the attribute value.
Example use: show_preloader=".loading"
17. default_loading_text — optional
95 |The default value is "uploading.." and it is translatable. When you don't have show_preloader set, the select file button's text will change to this attribute value while an upload is processing, and the icon will change to a spin icon (icons by fontello.com)
Example use: default_loading_text="Processing your file. please wait.."
18. on_success_dialog_prompt_value — optional
98 |This will let your uses get the media URI of what they have uploaded. A dialog box will prompt with acustom message and an input where they can copy the file URL. in the attribute value, you can set the message to show above the input in the dialog box.
Example use: on_success_dialog_prompt_value="Upload done! make sure to copy your URL below and save it!"
The function
103 | 104 |In your PHP template, you could call the shortcode with do_shortcode('[ajax-file-upload ..]') WordPress's native shortcode parser function. Or, there's this function ajax_file_upload() you can use instead, carry on.
ajax_file_upload( $args ) accepts an array of arguments, these arguments are basically the shortcode attributes! So, keep consulting the above list if you need an element to add to your function..
Here's an example use:
109 | 110 |$args = array( 111 | "unique_identifier" => "my_subscription_form_file_upload", 112 | "allowed_extensions" => "jpg, png, bmp, gif", 113 | "on_success_alert" => "Your file was uploaded. Please continue with your subscription operation." 114 | ); 115 | echo ajax_file_upload( $args ); 116 |117 | 118 |
Further usage
119 | 120 |Child theme
121 | 122 |This plugin supports child theme. You can copy the entire plugin file to your active theme, and there you can modifications and changes to all the plugin files except the ajax-file-upload.php which is the core file. Neat huh? useful when you want to customize the shortcode template more or edit a little bit of jQuery and CSS..
JavaScript events
125 | 126 |This plugin creates DOM events that you can hook into to perform your required actions. Here are the events created by far:
127 | 128 |afu_got_response
129 | 130 |afu? that's the plugin's prefix. This event is initiated when an upload is processed or not, mainly when the ajax request is completed successfully, and it has data attached to it which you can access through event.data method:
window.addEventListener( "afu_got_response", function(e){
133 | var data = e.data; // full data object
134 | if( data.response.success ) { // success
135 | console.log( data.response.media_uri ); // the uploaded media URL
136 | }
137 | }, false);
138 |
139 |
140 | Do a console.log(e.data) there's much more useful data included with the event's attached data.
afu_file_uploaded
145 | 146 |Same as the previous one, but afu_file_uploaded is only called when the file was successfully uploaded. You can use it to get the media URI with e.data.response.media_uri as you set the event listener
window.addEventListener( "afu_file_uploaded", function(e){
149 | if( "undefined" !== typeof e.data.response.media_uri ) {
150 | console.log( e.data.response.media_uri ); // the uploaded media URL
151 | }
152 | }, false);
153 |
154 |
155 | afu_error_uploading
156 | 157 |Runs when a file was not uploaded. Useful data are included about the file, the applied settings and the response.
158 | 159 |window.addEventListener( "afu_error_uploading", function(e){
160 | console.log( e.data ); // debugging
161 | }, false);
162 |
163 |
164 | afu_file_removed
165 | 166 |Runs when a file was not uploaded. Useful data are included about the file, the applied settings and the response.
167 | 168 |window.addEventListener( "afu_file_removed", function(e){
169 | console.log( e.data.this ); // the clicked button
170 | console.log( e.data.container ); // the container div of this button if you want to apply changes to its chilren or so
171 | }, false);
172 |
173 |
174 | Thank you!
175 | 176 |Thanks for reading about this plugin. This plugin is totally free and open-source, that means you can contribute to it to add many more cool features and improve it better. Interested? hit me up at samelh.com/contact/. AFU is available on the free open source software repository Github.
177 | 178 |If you like it by far, please take some time to leave us a ☆☆☆☆☆ rating on WordPress, a star ☆ on the Github repository, and thank you for your time!
179 | 180 |181 | Star on Github 182 | - Share on Twitter 183 | - Follow @Samuel_Elh on Twitter 184 | - Find support 185 | - samelh.com 186 |
187 | 188 |
27 |
28 |
33 |
34 |
208 |
--------------------------------------------------------------------------------
/license.txt:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 2, June 1991
3 |
4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc.
5 | 51 Franklin St, Fifth Floor, Boston, MA 02110, USA
6 |
7 | Everyone is permitted to copy and distribute verbatim copies
8 | of this license document, but changing it is not allowed.
9 |
10 | Preamble
11 |
12 | The licenses for most software are designed to take away your
13 | freedom to share and change it. By contrast, the GNU General Public
14 | License is intended to guarantee your freedom to share and change free
15 | software--to make sure the software is free for all its users. This
16 | General Public License applies to most of the Free Software
17 | Foundation's software and to any other program whose authors commit to
18 | using it. (Some other Free Software Foundation software is covered by
19 | the GNU Library General Public License instead.) You can apply it to
20 | your programs, too.
21 |
22 | When we speak of free software, we are referring to freedom, not
23 | price. Our General Public Licenses are designed to make sure that you
24 | have the freedom to distribute copies of free software (and charge for
25 | this service if you wish), that you receive source code or can get it
26 | if you want it, that you can change the software or use pieces of it
27 | in new free programs; and that you know you can do these things.
28 |
29 | To protect your rights, we need to make restrictions that forbid
30 | anyone to deny you these rights or to ask you to surrender the rights.
31 | These restrictions translate to certain responsibilities for you if you
32 | distribute copies of the software, or if you modify it.
33 |
34 | For example, if you distribute copies of such a program, whether
35 | gratis or for a fee, you must give the recipients all the rights that
36 | you have. You must make sure that they, too, receive or can get the
37 | source code. And you must show them these terms so they know their
38 | rights.
39 |
40 | We protect your rights with two steps: (1) copyright the software, and
41 | (2) offer you this license which gives you legal permission to copy,
42 | distribute and/or modify the software.
43 |
44 | Also, for each author's protection and ours, we want to make certain
45 | that everyone understands that there is no warranty for this free
46 | software. If the software is modified by someone else and passed on, we
47 | want its recipients to know that what they have is not the original, so
48 | that any problems introduced by others will not reflect on the original
49 | authors' reputations.
50 |
51 | Finally, any free program is threatened constantly by software
52 | patents. We wish to avoid the danger that redistributors of a free
53 | program will individually obtain patent licenses, in effect making the
54 | program proprietary. To prevent this, we have made it clear that any
55 | patent must be licensed for everyone's free use or not licensed at all.
56 |
57 | The precise terms and conditions for copying, distribution and
58 | modification follow.
59 |
60 | GNU GENERAL PUBLIC LICENSE
61 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
62 |
63 | 0. This License applies to any program or other work which contains
64 | a notice placed by the copyright holder saying it may be distributed
65 | under the terms of this General Public License. The "Program", below,
66 | refers to any such program or work, and a "work based on the Program"
67 | means either the Program or any derivative work under copyright law:
68 | that is to say, a work containing the Program or a portion of it,
69 | either verbatim or with modifications and/or translated into another
70 | language. (Hereinafter, translation is included without limitation in
71 | the term "modification".) Each licensee is addressed as "you".
72 |
73 | Activities other than copying, distribution and modification are not
74 | covered by this License; they are outside its scope. The act of
75 | running the Program is not restricted, and the output from the Program
76 | is covered only if its contents constitute a work based on the
77 | Program (independent of having been made by running the Program).
78 | Whether that is true depends on what the Program does.
79 |
80 | 1. You may copy and distribute verbatim copies of the Program's
81 | source code as you receive it, in any medium, provided that you
82 | conspicuously and appropriately publish on each copy an appropriate
83 | copyright notice and disclaimer of warranty; keep intact all the
84 | notices that refer to this License and to the absence of any warranty;
85 | and give any other recipients of the Program a copy of this License
86 | along with the Program.
87 |
88 | You may charge a fee for the physical act of transferring a copy, and
89 | you may at your option offer warranty protection in exchange for a fee.
90 |
91 | 2. You may modify your copy or copies of the Program or any portion
92 | of it, thus forming a work based on the Program, and copy and
93 | distribute such modifications or work under the terms of Section 1
94 | above, provided that you also meet all of these conditions:
95 |
96 | a) You must cause the modified files to carry prominent notices
97 | stating that you changed the files and the date of any change.
98 |
99 | b) You must cause any work that you distribute or publish, that in
100 | whole or in part contains or is derived from the Program or any
101 | part thereof, to be licensed as a whole at no charge to all third
102 | parties under the terms of this License.
103 |
104 | c) If the modified program normally reads commands interactively
105 | when run, you must cause it, when started running for such
106 | interactive use in the most ordinary way, to print or display an
107 | announcement including an appropriate copyright notice and a
108 | notice that there is no warranty (or else, saying that you provide
109 | a warranty) and that users may redistribute the program under
110 | these conditions, and telling the user how to view a copy of this
111 | License. (Exception: if the Program itself is interactive but
112 | does not normally print such an announcement, your work based on
113 | the Program is not required to print an announcement.)
114 |
115 | These requirements apply to the modified work as a whole. If
116 | identifiable sections of that work are not derived from the Program,
117 | and can be reasonably considered independent and separate works in
118 | themselves, then this License, and its terms, do not apply to those
119 | sections when you distribute them as separate works. But when you
120 | distribute the same sections as part of a whole which is a work based
121 | on the Program, the distribution of the whole must be on the terms of
122 | this License, whose permissions for other licensees extend to the
123 | entire whole, and thus to each and every part regardless of who wrote it.
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 |
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 |
134 | 3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 |
138 | a) Accompany it with the complete corresponding machine-readable
139 | source code, which must be distributed under the terms of Sections
140 | 1 and 2 above on a medium customarily used for software interchange; or,
141 |
142 | b) Accompany it with a written offer, valid for at least three
143 | years, to give any third party, for a charge no more than your
144 | cost of physically performing source distribution, a complete
145 | machine-readable copy of the corresponding source code, to be
146 | distributed under the terms of Sections 1 and 2 above on a medium
147 | customarily used for software interchange; or,
148 |
149 | c) Accompany it with the information you received as to the offer
150 | to distribute corresponding source code. (This alternative is
151 | allowed only for noncommercial distribution and only if you
152 | received the program in object code or executable form with such
153 | an offer, in accord with Subsection b above.)
154 |
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it. For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable. However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 |
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 |
172 | 4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License. Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 |
180 | 5. You are not required to accept this License, since you have not
181 | signed it. However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works. These actions are
183 | prohibited by law if you do not accept this License. Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 |
189 | 6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions. You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 |
197 | 7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License. If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all. For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 |
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 |
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices. Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 |
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 |
229 | 8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded. In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 |
237 | 9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time. Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 |
242 | Each version is given a distinguishing version number. If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation. If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 |
250 | 10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission. For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this. Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 |
258 | NO WARRANTY
259 |
260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 |
270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 |
280 | END OF TERMS AND CONDITIONS
281 |
--------------------------------------------------------------------------------
Welcome to AJAX File Upload v. 0.1!
29 | 30 |Thank you for using AJAX File Upload to quickly process your uploads on the go!
31 | 32 | A small preview
WpChats 3.0 profile editThis plugin will help you add file upload feature to your site, set maximum upload size, allowed file extensions, and much more through a simple shortcode or a custom function.
35 | 36 |Totally AJAX, your uploads will be processed faster and an elegant way. All you need to do is to add the shortcode to your content, or call the plugin's custom function whithin your code and that's it.
37 | 38 |Go to settings or carry on with the useful documentation
39 | 40 |The Shortcode
41 | 42 |You can use [ajax-file-upload] to output the AJAX file uploader, set its settings, markup, and much more through the shortcode attributes.
Shortcode attributes
45 | 46 |
47 |
48 |
55 |
56 | -
49 | $val ) : ?>
50 |
- >
57 |
58 |
113 |
114 | 1. unique_identifier — required
59 |This is a required attribute. Insert anything random that makes the uploader unique, used to store the uploader settings in the database and get them while processing a file for the shortcode in use.
Example use: unique_identifier="my_contact_form"
2. max_size — optional
62 |Allows you to set the maximum file size to upload in KB. 1 MB is equal to 1000 KB.
Example use: max_size=3000 for 3 MB upload
3. allowed_extensions — optional
65 |With this attribute you can set the allowed file extensions to upload. Please separate the extensions with commas.
Example use: allowed_extensions="pdf,txt"
4. permissions — optional
68 |Set the required permission for a user to upload a file. You can set all for all users (even logged-out ones), or logged_in for logged-in users only, or a custom user role e.g author. If you choose to set a role, the current user is required to have that role in order to process an upload.
5. on_success_alert — optional
71 |Alert the user that their upload is done. You can set custom messages to output within the dialog. It is optional, and no default alert is there if you don't set this attribute.
Example use: on_success_alert="Your file was successfully uploaded"
6. on_fail_alert — optional
74 |When a file is not processed successfully, you can use this attribute to alert the user with a custom message.
Example use: on_fail_alert="We couldn't have your file uploaded. Try again?"
7. on_fail_alert_error_message — optional
77 |An error message is always included in the AJAX response while a file was not processed with success. To alert this message to the user, you just need to add this attribute with some value that makes it true.
Example use: on_fail_alert_error_message="true"
8. on_success_set_input_value — optional
80 |You might have a hidden or visible input within your form where you want to put the uploaded media URL. If so, then use this attribute and put that field selector as the attribute value. If this field was not found in the DOM, an error will be added to the console.
Example use: on_success_set_input_value="#my_hidden_input"
9. set_background_image — optional
83 |When uploading an image, you probably want to use this attribute to set an element's background-image property with the returned image upload URL. The value has to be a valid element selector.
Example use: set_background_image=".cover-photo-container"
10. set_image_source — optional
86 |Same here, when uploading an image you would probably want to set an image source attribute with the returned image upload URL. If so then provide this image selector in the DOM.
Example use: set_image_source="img.profile-pic"
11. disallow_remove_button — optional
89 |This attribute allows you to not provide a file delete button with the shortcode output. It can be handy when you don't want a user to multiple files everytime as they hit this button. Set its value and the button won't be there.
Example use: disallow_remove_button="1"
12. disallow_reupload — optional
92 |This can be handy to prevent users to upload multiple files. Set its value to something that makes it true, as you do, when a user uploads a file, the upload and remove button will both disappear, and the select one will become disabled.
Example use: disallow_reupload=""
13 upload_button_value — optional
95 |The default value is "upload" and translatable through the admin settings. Lets you edit the upload button text.
Example use: upload_button_value="upload file"
14. select_file_button_value — optional
98 |The default value is "choose file" and translatable through the admin settings. Lets you edit the select button text..
Example use: select_file_button_value="choisir un fichier"
15. remove_file_button_value — optional
101 |The default value is "remove" and translatable through the admin settings. Lets you edit the remove button text..
Example use: remove_file_button_value="click to remove this file"
16. show_preloader — optional
104 |If you have a hidden preloader which you want to show while the upload is being processed, provide its selector in the attribute value.
Example use: show_preloader=".loading"
17. default_loading_text — optional
107 |The default value is "uploading.." and it is translatable. When you don't have show_preloader set, the select file button's text will change to this attribute value while an upload is processing, and the icon will change to a spin icon (icons by fontello.com)
Example use: default_loading_text="Processing your file. please wait.."
18. on_success_dialog_prompt_value — optional
110 |This will let your uses get the media URI of what they have uploaded. A dialog box will prompt with acustom message and an input where they can copy the file URL. in the attribute value, you can set the message to show above the input in the dialog box.
Example use: on_success_dialog_prompt_value="Upload done! make sure to copy your URL below and save it!"
The function
115 | 116 |In your PHP template, you could call the shortcode with do_shortcode('[ajax-file-upload ..]') WordPress's native shortcode parser function. Or, there's this function ajax_file_upload() you can use instead, carry on.
ajax_file_upload( $args ) accepts an array of arguments, these arguments are basically the shortcode attributes! So, keep consulting the above list if you need an element to add to your function..
Here's an example use:
121 | 122 |123 | $args = array( 124 | "unique_identifier" => "my_subscription_form_file_upload", 125 | "allowed_extensions" => "jpg, png, bmp, gif", 126 | "on_success_alert" => "Your file was uploaded. Please continue with your subscription operation." 127 | ); 128 | echo ajax_file_upload( $args ); 129 |130 | 131 |
Further usage
132 | 133 |Child theme
134 | 135 |This plugin supports child theme. You can copy the entire plugin file to your active theme, and there you can modifications and changes to all the plugin files except the ajax-file-upload.php which is the core file. Neat huh? useful when you want to customize the shortcode template more or edit a little bit of jQuery and CSS..
JavaScript events
138 | 139 |This plugin creates DOM events that you can hook into to perform your required actions. Here are the events created by far:
140 | 141 |afu_got_response
142 | 143 |afu? that's the plugin's prefix. This event is initiated when an upload is processed or not, mainly when the ajax request is completed successfully, and it has data attached to it which you can access through event.data method:
146 | window.addEventListener( "afu_got_response", function(e){
147 | var data = e.data; // full data object
148 | if( data.response.success ) { // success
149 | console.log( data.response.media_uri ); // the uploaded media URL
150 | }
151 | }, false);
152 |
153 |
154 | Do a console.log(e.data) there's much more useful data included with the event's attached data.
afu_file_uploaded
159 | 160 |Same as the previous one, but afu_file_uploaded is only called when the file was successfully uploaded. You can use it to get the media URI with e.data.response.media_uri as you set the event listener
163 | window.addEventListener( "afu_file_uploaded", function(e){
164 | if( "undefined" !== typeof e.data.response.media_uri ) {
165 | console.log( e.data.response.media_uri ); // the uploaded media URL
166 | }
167 | }, false);
168 |
169 |
170 | afu_error_uploading
171 | 172 |Runs when a file was not uploaded. Useful data are included about the file, the applied settings and the response.
173 | 174 |
175 | window.addEventListener( "afu_error_uploading", function(e){
176 | console.log( e.data ); // debugging
177 | }, false);
178 |
179 |
180 | afu_file_removed
181 | 182 |Runs when a file was not uploaded. Useful data are included about the file, the applied settings and the response.
183 | 184 |
185 | window.addEventListener( "afu_file_removed", function(e){
186 | console.log( e.data.this ); // the clicked button
187 | console.log( e.data.container ); // the container div of this button if you want to apply changes to its children or so
188 | }, false);
189 |
190 |
191 | Thank you!
192 | 193 |Thanks for reading about this plugin. This plugin is totally free and open-source, that means you can contribute to it to add many more cool features and improve it better. Interested? hit me up at samelh.com/contact/. AFU is available on the free open source software repository Github.
194 | 195 |If you like it by far, please take some time to leave us a ☆☆☆☆☆ rating on WordPress, a star ☆ on the Github repository, and thank you for your time!
196 | 197 | 198 | 199 |200 | Star on Github 201 | - Share on Twitter 202 | - Follow @Samuel_Elh on Twitter 203 | - Find support 204 | - samelh.com 205 |
206 | 207 |