-
Notifications
You must be signed in to change notification settings - Fork 45
/
readme.txt
395 lines (311 loc) · 16.6 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
=== New User Approve ===
Contributors: wpexpertsio
Donate link: https://newuserapprove.com
Tags: users, registration, sign up, user management, login
Requires at least: 3.5.1
Tested up to: 5.4
Stable tag: 1.8
License: GPLv2 or later
License URI: http://www.gnu.org/licenses/gpl-2.0.html
New User Approve allows a site administrator to approve a user before they
are able to login to the site.
== Description ==
On a normal WordPress site, once a new user registers, the user is created in the database. Then an email is sent to the new user with their login credentials. Very simple. As it should be.
The New User Approve plugin modifies the registration process. When a user registers for the site, the user gets created and then an email gets sent to the administrators of the site. An administrator then is expected to either approve or deny the registration request. An email is then sent to the user indicating whether they were approved or denied. If the user has been approved, the email will include the login credentials. Until a user is approved, the user will not be able to login to the site.
Only approved users will be allowed to login to site. Users waiting for approval as well as denied users will not be able to login to site.
A user's status can be updated even after the initial approval/denial.
Each user that exists before New User Approve has been activated will be treated as an approved user.
**Default WordPress registration process:**
1. User registers.
2. User is shown message to check email.
3. Login credentials are sent to new user in an email.
4. User logs in to site using login credentials.
5. Admin is notified of new user sign up via email.
**WordPress registration process with New User Approve plugin activated:**
1. User registers for access to site.
2. User is shown message to wait for approval.
3. Admin is notified of new user sign up via email.
4. Admin goes to wp-admin to approve or deny new user.
5. Email is sent to user. If approved, email will include login credentials.
6. User logs in to site using login credentials.
**[Follow New User Approve on Github](https://github.com/picklewagon/new-user-approve)**
Further support at [newuserapprove.com](http://newuserapprove.com/).
**Customize**
New User Approve allows for customizations by using custom actions and filters. You can find out more about these by browsing the source code.
A commercial plugin that adds a config panel for customization is also available at [https://newuserapprove.com/options-addon/](https://newuserapprove.com/options-addon/).
== Installation ==
1. Upload new-user-approve to the wp-content/plugins directory or download from the WordPress backend (Plugins -> Add New -> search for 'new user approve')
2. Activate the plugin through the Plugins menu in WordPress
3. No configuration necessary.
== Frequently Asked Questions ==
= Why am I not getting the emails when a new user registers? =
The New User Approve plugin uses the functions provided by WordPress to send email. Make sure your host is setup correctly to send email if this happens.
= How do I customize the email address and/or name when sending notifications to users? =
This is not a function of the plugin but of WordPress. WordPress provides the *wp_mail_from* and *wp_mail_from_name* filters to allow you to customize this. There are also a number of plugins that provide a setting to change this to your liking.
* [wp mail from](http://wordpress.org/extend/plugins/wp-mailfrom/)
* [Mail From](http://wordpress.org/extend/plugins/mail-from/)
= What happens to the user's status after the plugin is deactivated? =
If you deactivate the plugin, their status doesn't matter. The status that the plugin uses is only used by the plugin. All users will be allowed to login as long as they have their username and passwords.
= Are there any known issues with the New User Approve plugin? =
We are aware of a few issues with multisite
1. The status filters on users.php do not work correctly
2. The bubble that shows next to the users link to show the number of pending users does not show
== Screenshots ==
1. The backend to manage approving and denying users. This is an alternative to approving users.
2. Integration with WordPress Users admin page.
3. Filter users by status.
4. Approve or deny users using the bulk edit feature in WordPress.
5. Custom messages on the login screen.
== Changelog ==
= 1.8 =
* Tested with WordPress 5.4
* Code Optimization
= 1.7.6 =
* Fixed: Formatting of readme.txt had line breaks where they should have been
* Fixed: Fix how deny_user() gets user_email
* Courtesy of [jrequiroso](https://github.com/jrequiroso)
* https://github.com/picklewagon/new-user-approve/pull/22
* Fixed: Show unapproved user error message when the user attempts to reset password
* Updated: Swedish translations
* Courtesy of [adevade](https://github.com/adevade)
* https://github.com/picklewagon/new-user-approve/pull/59
* Updated: Updates to admin approval screen
* Courtesy of [adevade](https://github.com/adevade)
* https://github.com/picklewagon/new-user-approve/pull/60
* Added: Don't allow a super admin to be denied or approved
* https://github.com/picklewagon/new-user-approve/pull/19
* Added: readme.md to show content in github
= 1.7.5 =
* Fixed: User status filter in admin was not using database prefix
* Courtesy of [Oizopower](https://github.com/Oizopower)
* https://github.com/picklewagon/new-user-approve/pull/50
* Fixed: Optimize user status list so it can be used with many users
* Fixed: Updated transient to populate with user counts instead of user list
* Updated: Modify output of user counts on dashboard
* Updated: Polish translations
* Courtesy of [pik256](http://wordpress.org/support/profile/1271256)
* Added: Missing string to translation file
* Courtesy of [spaszs](https://profiles.wordpress.org/spaszs/)
* Added: Bulgarian translation
* Courtesy of [spaszs](https://profiles.wordpress.org/spaszs/)
= 1.7.4 =
* Fixed: Corrected erroneous SQL query when filtering users
* Fixed: User filters
* Courtesy of [julmuell](https://github.com/julmuell)
* https://github.com/picklewagon/new-user-approve/pull/44
* Fixed: Show a user status in the filters only if at least one user has that status
= 1.7.3 =
* place content in metaboxes in place of dynamically pulling from website
* tested with WordPress 4.3.1
= 1.7.2 =
* tested with WordPress 4.1
* fix translation bug
* add bubble to user menu for pending users
* Courtesy of [howdy_mcgee](https://wordpress.org/support/profile/howdy_mcgee)
* https://wordpress.org/support/topic/get-number-of-pending-users#post-5920371
= 1.7.1 =
* fix code causing PHP notices
* don't show admin notice for registration setting if S2Member plugin is active
* fix issue causing empty password in approval email
* update translation files
= 1.7 =
* email/message tags
* refactor messages
* send admin approval email after the user has been created
* tested with WordPress 4.0
* finish updates in preparation of option addon plugin
= 1.6 =
* improve actions and filters
* refactor messages to make them easier to override
* show admin notice if the membership setting is turned off
* fix bug preventing approvals/denials when using filter
* add sidebar in admin to help with support
* unit tests
* shake the login form when attempting to login as unapproved user
* updated French translation
= 1.5.8 =
* tested with WordPress 3.9
* fix bug preventing the notice from hiding on legacy page
= 1.5.7 =
* fix bug that was preventing bulk approval/denials
= 1.5.6 =
* add more translations
= 1.5.5 =
* allow approval from legacy page
= 1.5.4 =
* fix bug that prevents emails from being sent to admins
= 1.5.3 =
* add filter for link to approve/deny users
* add filter for adding more email addresses to get notifications
* fix bug that prevents users to be approved and denied when requested
* fix bug that prevents the new user email from including a password
* fix bug that prevents search results from showing when searching users
= 1.5.2 =
* fix link to approve new users in email to admin
* fix bug with sending emails to new approved users
= 1.5.1 =
* fix bug when trying to install on a site with WP 3.5.1
= 1.5 =
* add more logic to prevent unwanted password resets
* add more translations
* minor bug fixes
* use core definition of tabs
* user query updates (requires 3.5)
* add status attribute to user profile page
* integration with core user table (bulk approve, filtering, etc.)
* tested with WordPress 3.6
* set email header when sending email
* more filters and actions
= 1.4.2 =
* fix password recovery bug if a user does not have an approve-status meta field
* add more translations
* tested with WordPress 3.5
= 1.4.1 =
* delete transient of user statuses when a user is deleted
= 1.4 =
* add filters
* honor the redirect if there is one set when registering
* add actions for when a user is approved or denied
* add a filter to bypass password reset
* add more translations
* add user counts by status to dashboard
* store the users by status in a transient
= 1.3.4 =
* remove unused screen_layout_columns filter
* tested with WordPress 3.4
= 1.3.3 =
* fix bug showing error message permanently on login page
= 1.3.2 =
* fix bug with allowing wrong passwords
= 1.3.1 =
* add czech, catalan, romanian translations
* fix formatting issues in readme.txt
* add a filter to modify who has access to approve and deny users
* remove deprecated function calls when a user resets a password
* don't allow a user to login without a password
= 1.3 =
* use the User API to retrieve a user instead of querying the db
* require at least WordPress 3.1
* add validate_user function to fix authentication problems
* add new translations
* get rid of plugin errors with WP_DEBUG set to true
= 1.2.6 =
* fix to include the deprecated code for user search
= 1.2.5 =
* add french translation
= 1.2.4 =
* add greek translation
= 1.2.3 =
* add danish translation
= 1.2.2 =
* fix localization to work correctly
* add polish translation
= 1.2.1 =
* check for the existence of the login_header function to make compatible with functions that remove it
* added "Other Notes" page in readme.txt with localization information.
* added belarusian translation files
= 1.2 =
* add localization support
* add a changelog to readme.txt
* remove plugin constants that have been defined since 2.6
* correct the use of db prepare statements/use prepare on all SQL statements
* add wp_enqueue_style for the admin style sheet
= 1.1.3 =
* replace calls to esc_url() with clean_url() to make plugin compatible with versions less than 2.8
= 1.1.2 =
* fix the admin ui tab interface for 2.8
* add a link to the users profile in the admin interface
* fix bug when using email address to retrieve lost password
* show blog title correctly on login screen
* use get_option() instead of get_settings()
= 1.1.1 =
* fix approve/deny links
* fix formatting issue with email to admin to approve user
= 1.1 =
* correctly display error message if registration is empty
* add a link to the options page from the plugin dashboard
* clean up code
* style updates
* if a user is created through the admin interface, set the status as approved instead of pending
* add avatars to user management admin page
* improvements to SQL used
* verify the user does not already exist before the process is started
* add nonces to approve and deny actions
* temporary fix for pagination bug
== Upgrade Notice ==
= 1.5.3 =
Download version 1.5.3 immediately! Some bugs have been fixed that have been affecting how the plugin worked.
= 1.5 =
A long awaited upgrade that includes better integration with WordPress core. Requires at least WordPress 3.5.
= 1.3 =
This version fixes some issues when authenticating users. Requires at least WordPress 3.1.
= 1.3.1 =
Download version 1.3.1 immediately! A bug was found in version 1.3 that allows a user to login without using password.
= 1.3.2 =
Download version 1.3.2 immediately! A bug was found in version 1.3 that allows a user to login using any password.
== Other Notes ==
The code for this plugin is also available at Github - https://github.com/picklewagon/new-user-approve. Pull requests welcomed.
= Filters =
* *new_user_approve_user_status* - modify the list of users shown in the tables
* *new_user_approve_request_approval_message* - modify the request approval message
* *new_user_approve_request_approval_subject* - modify the request approval subject
* *new_user_approve_approve_user_message* - modify the user approval message
* *new_user_approve_approve_user_subject* - modify the user approval subject
* *new_user_approve_deny_user_message* - modify the user denial message
* *new_user_approve_deny_user_subject* - modify the user denial subject
* *new_user_approve_pending_message* - modify message user sees after registration
* *new_user_approve_registration_message* - modify message after a successful registration
* *new_user_approve_register_instructions* - modify message that appears on registration screen
* *new_user_approve_pending_error* - error message shown to pending users when attempting to log in
* *new_user_approve_denied_error* - error message shown to denied users when attempting to log in
= Actions =
* *new_user_approve_user_approved* - after the user has been approved
* *new_user_approve_user_denied* - after the user has been denied
* *new_user_approve_approve_user* - when the user has been approved
* *new_user_approve_deny_user* - when the user has been denied
= Premium Features =
* Provide Ability To remove plugin stats from admin dashboard
* Remove the admin panel specifically added to update a user's status, from wordpress dashboard.
* Customize the welcome message displayed above wordpress login form.
* Customize the 'Pending error message' displayed when user tries to login but his account is still pending approval.
* Customize the 'Denied error message' displayed when user tries to login but his account is denied approval.
* Customize the welcome message displayed above wordpress Registration form.
* Customize the Registration complete message displayed after user submits Registration form for approval.
* Provide Ability To Send notification emails to all admins
* Notify admins when a user's status is updated
* Disable notification emails to current site admin
* Customize the email sent to admin when a user registers for the site
* Customize the email sent to user when his profile is approved.
* Customize the email sent to user when his profile is denied.
* Suppress denial notification
* Provides option to send all notification as html.
* It Provides you Different template tags which can be used in Notification Emails and Other messages on site.
[Download Premium from here](https://newuserapprove.com/options-addon)
= Translations =
The plugin has been prepared to be translated. If you want to help to translate the plugin to your language, please have a look at the localization/new-user-approve.pot file which contains all definitions and may be used with a gettext editor like Poedit (Windows). More information can be found on the [Codex](http://codex.wordpress.org/Translating_WordPress).
When sending me your translation files, please send me your wordpress.org username as well.
* Belarussian translation by [Fat Cow](http://www.fatcow.com/)
* Brazilian Portuguese translation by [leogermani](http://profiles.wordpress.org/leogermani/)
* Bulgarian translation by [spaszs](https://profiles.wordpress.org/spaszs/)
* Catalan translation by [xoanet](http://profiles.wordpress.org/xoanet/)
* Croatian translation by Nik
* Czech translation by [GazikT](http://profiles.wordpress.org/gazikt/)
* Danish translation by [GeorgWP](http://wordpress.org/support/profile/georgwp)
* Dutch translation by [Ronald Moolenaar](http://profiles.wordpress.org/moolie/)
* Estonian translation by (Rait Huusmann)(http://profiles.wordpress.org/raitulja/)
* Finnish translation by Tonttu-ukko
* French translation by [Philippe Scoffoni](http://philippe.scoffoni.net/)
* German translation by Christoph Ploedt
* Greek translation by [Leftys](http://alt3rnet.info/)
* Hebrew translation by [Udi Burg](http://blog.udiburg.com)
* Hungarian translation by Gabor Varga
* Italian translation by [Pierfrancesco Marsiaj](http://profiles.wordpress.org/pierinux/)
* Lithuanian translation by [Ksaveras](http://profiles.wordpress.org/xawiers)
* Persian translation by [alimir](http://profiles.wordpress.org/alimir)
* Polish translation by [pik256](http://wordpress.org/support/profile/1271256)
* Romanian translation by [Web Hosting Geeks](http://webhostinggeeks.com/)
* Russian translation by [Alexey](http://wordpress.org/support/profile/asel)
* Serbo-Croation translation by [Web Hosting Hub](http://www.webhostinghub.com/)
* Slovakian translation by Boris Gereg
* Spanish translation by [Eduardo Aranda](http://sinetiks.com/)
* Swedish translation by [Per Bjälevik](http://pastis.tauzero.se)