-
Notifications
You must be signed in to change notification settings - Fork 0
/
db_wp-admin_includes_user.html
463 lines (449 loc) · 15.5 KB
/
db_wp-admin_includes_user.html
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
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
<html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>WordPress Trunk</title><link rel="stylesheet" href="css/black-tie/jquery-ui-1.8.2.custom.css" type="text/css"></link><link rel="stylesheet" href="css/jquery.treeview.css" type="text/css"></link><link rel="stylesheet" href="css/theme.css" type="text/css"></link><script type="text/javascript" src="js/jquery-1.4.2.min.js"></script><script type="text/javascript" src="js/jquery-ui-1.8.2.custom.min.js"></script><script type="text/javascript" src="js/jquery.cookie.js"></script><script type="text/javascript" src="js/jquery.treeview.js"></script><script type="text/javascript">
$(document).ready(function() {
$(".filetree").treeview({
collapsed: true,
persist: "cookie"
});
$("#accordion").accordion({
collapsible: true,
autoHeight: false,
fillSpace: true
});
$(".tabs").tabs();
});
</script></head><body><div xmlns="" id="content">
<script type="text/javascript" src="js/menu.js"></script><script>
function filterElements()
{
inherited = !$('a#show-inherited').hasClass('deselected');
public = !$('a#show-public').hasClass('deselected');
protected = !$('a#show-protected').hasClass('deselected');
private = !$('a#show-private').hasClass('deselected');
$('div.public').each(function(index, val) {
$(val).toggle(public && !($(val).hasClass('inherited_from') && !inherited));
});
$('div.protected').each(function(index, val) {
$(val).toggle(protected && !($(val).hasClass('inherited_from') && !inherited));
});
$('div.private').each(function(index, val) {
$(val).toggle(private && !($(val).hasClass('inherited_from') && !inherited));
});
}
$(document).ready(function() {
$('a.gripper').click(function() {
$(this).nextAll('div.code-tabs').slideToggle();
$(this).children('img').toggle();
return false;
});
$('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').css('cursor', 'pointer');
$('div.method code span.highlight,div.function code span.highlight,div.constant code span.highlight,div.property code span.highlight').click(function() {
$(this).parent().nextAll('div.code-tabs').slideToggle();
$(this).parent().prevAll('a.gripper').children('img').toggle();
return false;
});
$('div.code-tabs').hide();
$('a.gripper').show();
$('div.code-tabs:empty').prevAll('a.gripper').html('');
$('div.file-nav').show();
$('a#show-public, a#show-protected, a#show-private, a#show-inherited').click(function(){
$(this).toggleClass('deselected');
if ($(this).hasClass('deselected')) {
$(this).fadeTo('fast', '0.4');
} else {
$(this).fadeTo('fast', '1.0');
}
filterElements();
return false;
});
$('a#show-protected, a#show-private').click();
});
</script><h1 class="file">wp-admin/includes/user.php</h1>
<div class="file-nav">
<ul id="file-nav"><li><a href="#top">Global</a></li></ul>
<div style="float: right;padding-right: 20px;">
Show:
<a href="#" id="show-public"><img src="images/icons/visibility_public.png"></a><a href="#" id="show-protected"><img src="images/icons/visibility_protected.png"></a><a href="#" id="show-private"><img src="images/icons/visibility_private.png"></a><a href="#" id="show-inherited"><span class="attribute">inherited</span></a>
</div>
</div>
<a name="top" class="anchor"></a><div id="file-description">
<p class="short-description">WordPress user administration API.</p>
<div class="long-description">
</div>
</div>
<dl class="file-info">
<dt>Package</dt>
<dd>WordPress
</dd>
<dt>Subpackage</dt>
<dd>Administration
</dd>
</dl>
<a name="functions" class="anchor"></a><h2>Functions</h2>
<div>
<a id="::add_user()" class="anchor"></a><div class="function ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">add_user</span><span class="nb-faded-text">(
)
</span>
:
null|<a href="db_wp-includes_class-wp-error.html#%5CWP_Error">\WP_Error</a>|int</code><div class="description"><p class="short_description">Creates a new user from the "Users" form using $_POST information.</p></div>
<div class="code-tabs">
<div class="long-description"><p>It seems that the first half is for backwards compatibility, but only
has the ability to alter the user's role. WordPress core seems to
use this function only in the second way, running edit_user() with
no id so as to create a new user.</p>
</div>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td>null|<a href="db_wp-includes_class-wp-error.html#%5CWP_Error">\WP_Error</a>|int</td>
<td>Null when adding user, WP_Error or User ID integer when no parameters.</td>
</tr>
</table>
<strong>Details</strong><dl class="function-info">
<dt>Since</dt>
<dd>2.0
</dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="::default_password_nag()" class="anchor"></a><div class="function ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">default_password_nag</span><span class="nb-faded-text">(
)
</span>
:
void</code><div class="description"><p class="short_description"></p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Details</strong><dl class="function-info">
<dt>Since</dt>
<dd>2.8.0
</dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="::default_password_nag_edit_user()" class="anchor"></a><div class="function ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">default_password_nag_edit_user</span><span class="nb-faded-text">(
$user_ID, $old_data
)
</span>
:
void</code><div class="description"><p class="short_description"></p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$user_ID</th>
<td></td>
<td><em></em></td>
</tr>
<tr>
<th>$old_data</th>
<td></td>
<td><em></em></td>
</tr>
</table>
<strong>Details</strong><dl class="function-info">
<dt>Since</dt>
<dd>2.8.0
</dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="::default_password_nag_handler()" class="anchor"></a><div class="function ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">default_password_nag_handler</span><span class="nb-faded-text">(
$errors
=
false
)
</span>
:
void</code><div class="description"><p class="short_description"></p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$errors</th>
<td></td>
<td><em></em></td>
</tr>
</table>
<strong>Details</strong><dl class="function-info">
<dt>Since</dt>
<dd>2.8.0
</dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="::edit_user()" class="anchor"></a><div class="function ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">edit_user</span><span class="nb-faded-text">(
int $user_id
=
0
)
</span>
:
int</code><div class="description"><p class="short_description">Edit user settings based on contents of $_POST</p></div>
<div class="code-tabs">
<div class="long-description"><p>Used on user-edit.php and profile.php to manage and process user options, passwords etc.</p>
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$user_id</th>
<td>int</td>
<td><em><p>Optional. User ID.</p></em></td>
</tr>
</table>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td>int</td>
<td>user id of the updated user</td>
</tr>
</table>
<strong>Details</strong><dl class="function-info">
<dt>Since</dt>
<dd>2.0
</dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="::get_editable_roles()" class="anchor"></a><div class="function ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">get_editable_roles</span><span class="nb-faded-text">(
)
</span>
:
\unknown</code><div class="description"><p class="short_description">Fetch a filtered list of user roles that the current user is
allowed to edit.</p></div>
<div class="code-tabs">
<div class="long-description"><p>Simple function who's main purpose is to allow filtering of the
list of roles in the $wp_roles object so that plugins can remove
inappropriate ones depending on the situation or user making edits.
Specifically because without filtering anyone with the edit_users
capability can edit others to be administrators, even if they are
only editors or authors. This filter allows admins to delegate
user management.</p>
</div>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td>\unknown</td>
<td></td>
</tr>
</table>
<strong>Details</strong><dl class="function-info">
<dt>Since</dt>
<dd>2.8
</dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="::get_user_to_edit()" class="anchor"></a><div class="function ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">get_user_to_edit</span><span class="nb-faded-text">(
int $user_id
)
</span>
:
object</code><div class="description"><p class="short_description">Retrieve user data and filter it.</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$user_id</th>
<td>int</td>
<td><em><p>User ID.</p></em></td>
</tr>
</table>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td>object</td>
<td>WP_User object with user data.</td>
</tr>
</table>
<strong>Details</strong><dl class="function-info">
<dt>Since</dt>
<dd>2.0.5
</dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="::get_users_drafts()" class="anchor"></a><div class="function ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">get_users_drafts</span><span class="nb-faded-text">(
int $user_id
)
</span>
:
array</code><div class="description"><p class="short_description">Retrieve the user's drafts.</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$user_id</th>
<td>int</td>
<td><em><p>User ID.</p></em></td>
</tr>
</table>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td>array</td>
<td></td>
</tr>
</table>
<strong>Details</strong><dl class="function-info">
<dt>Since</dt>
<dd>2.0.0
</dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="::wp_delete_user()" class="anchor"></a><div class="function ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">wp_delete_user</span><span class="nb-faded-text">(
int $id, int $reassign
=
'novalue'
)
</span>
:
bool</code><div class="description"><p class="short_description">Remove user and optionally reassign posts and links to another user.</p></div>
<div class="code-tabs">
<div class="long-description"><p>If the $reassign parameter is not assigned to an User ID, then all posts will
be deleted of that user. The action 'delete_user' that is passed the User ID
being deleted will be run after the posts are either reassigned or deleted.
The user meta will also be deleted that are for that User ID.</p>
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$id</th>
<td>int</td>
<td><em><p>User ID.</p></em></td>
</tr>
<tr>
<th>$reassign</th>
<td>int</td>
<td><em><p>Optional. Reassign posts and links to new User ID.</p></em></td>
</tr>
</table>
<strong>Returns</strong><table class="argument-info">
<thead><tr>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<td>bool</td>
<td>True when finished.</td>
</tr>
</table>
<strong>Details</strong><dl class="function-info">
<dt>Since</dt>
<dd>2.0.0
</dd>
</dl>
</div>
<div class="clear"></div>
</div>
<a id="::wp_revoke_user()" class="anchor"></a><div class="function ">
<a href="#" class="gripper"><img src="images/icons/arrow_right.png"><img src="images/icons/arrow_down.png" style="display: none;"></a><code><img src="images/icons/function.png" alt="function"><span class="highlight">wp_revoke_user</span><span class="nb-faded-text">(
int $id
)
</span>
:
void</code><div class="description"><p class="short_description">Remove all capabilities from user.</p></div>
<div class="code-tabs">
<div class="long-description">
</div>
<strong>Parameters</strong><table class="argument-info">
<thead><tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr></thead>
<tr>
<th>$id</th>
<td>int</td>
<td><em><p>User ID.</p></em></td>
</tr>
</table>
<strong>Details</strong><dl class="function-info">
<dt>Since</dt>
<dd>2.1.0
</dd>
</dl>
</div>
<div class="clear"></div>
</div>
</div>
</div>
<small xmlns="" class="footer">Documentation was generated by <a href="http://docblox-project.org">DocBlox 0.14.1</a>.
</small></body></html>