Skip to content

Commit a02a3e6

Browse files
committed
Move signup under user command
1 parent d5592a6 commit a02a3e6

File tree

5 files changed

+214
-212
lines changed

5 files changed

+214
-212
lines changed

README.md

Lines changed: 180 additions & 178 deletions
Original file line numberDiff line numberDiff line change
@@ -3344,184 +3344,6 @@ These fields are optionally available:
33443344

33453345

33463346

3347-
### wp signup
3348-
3349-
Manages signups on a multisite installation.
3350-
3351-
~~~
3352-
wp signup
3353-
~~~
3354-
3355-
**EXAMPLES**
3356-
3357-
# List signups.
3358-
$ wp signup list
3359-
+-----------+------------+---------------------+---------------------+--------+------------------+
3360-
| signup_id | user_login | user_email | registered | active | activation_key |
3361-
+-----------+------------+---------------------+---------------------+--------+------------------+
3362-
| 1 | bobuser | [email protected] | 2024-03-13 05:46:53 | 1 | 7320b2f009266618 |
3363-
| 2 | johndoe | [email protected] | 2024-03-13 06:24:44 | 0 | 9068d859186cd0b5 |
3364-
+-----------+------------+---------------------+---------------------+--------+------------------+
3365-
3366-
# Activate signup.
3367-
$ wp signup activate 2
3368-
Success: Signup 2 activated. Password: bZFSGsfzb9xs
3369-
3370-
# Delete signup.
3371-
$ wp signup delete 3
3372-
Success: Signup 3 deleted.
3373-
3374-
3375-
3376-
### wp signup activate
3377-
3378-
Activates one or more signups.
3379-
3380-
~~~
3381-
wp signup activate <signup>...
3382-
~~~
3383-
3384-
**OPTIONS**
3385-
3386-
<signup>...
3387-
The signup ID, user login, user email, or activation key of the signup(s) to activate.
3388-
3389-
**EXAMPLES**
3390-
3391-
# Activate signup.
3392-
$ wp signup activate 2
3393-
Success: Signup 2 activated. Password: bZFSGsfzb9xs
3394-
3395-
3396-
3397-
### wp signup delete
3398-
3399-
Deletes one or more signups.
3400-
3401-
~~~
3402-
wp signup delete <signup>...
3403-
~~~
3404-
3405-
**OPTIONS**
3406-
3407-
<signup>...
3408-
The signup ID, user login, user email, or activation key of the signup(s) to delete.
3409-
3410-
**EXAMPLES**
3411-
3412-
# Delete signup.
3413-
$ wp signup delete 3
3414-
Success: Signup 3 deleted.
3415-
3416-
3417-
3418-
### wp signup get
3419-
3420-
Gets details about a signup.
3421-
3422-
~~~
3423-
wp signup get <signup> [--field=<field>] [--fields=<fields>] [--format=<format>]
3424-
~~~
3425-
3426-
**OPTIONS**
3427-
3428-
<signup>
3429-
The signup ID, user login, user email, or activation key.
3430-
3431-
[--field=<field>]
3432-
Instead of returning the whole signup, returns the value of a single field.
3433-
3434-
[--fields=<fields>]
3435-
Limit the output to specific fields. Defaults to all fields.
3436-
3437-
[--format=<format>]
3438-
Render output in a particular format.
3439-
---
3440-
default: table
3441-
options:
3442-
- table
3443-
- csv
3444-
- json
3445-
- yaml
3446-
---
3447-
3448-
**EXAMPLES**
3449-
3450-
# Get signup.
3451-
$ wp signup get 1 --field=user_login
3452-
bobuser
3453-
3454-
# Get signup and export to JSON file.
3455-
$ wp signup get bobuser --format=json > bobuser.json
3456-
3457-
3458-
3459-
### wp signup list
3460-
3461-
Lists signups.
3462-
3463-
~~~
3464-
wp signup list [--<field>=<value>] [--field=<field>] [--fields=<fields>] [--format=<format>]
3465-
~~~
3466-
3467-
[--<field>=<value>]
3468-
Filter the list by a specific field.
3469-
3470-
[--field=<field>]
3471-
Prints the value of a single field for each signup.
3472-
3473-
[--fields=<fields>]
3474-
Limit the output to specific object fields.
3475-
3476-
[--format=<format>]
3477-
Render output in a particular format.
3478-
---
3479-
default: table
3480-
options:
3481-
- table
3482-
- csv
3483-
- ids
3484-
- json
3485-
- count
3486-
- yaml
3487-
---
3488-
3489-
**AVAILABLE FIELDS**
3490-
3491-
These fields will be displayed by default for each signup:
3492-
3493-
* signup_id
3494-
* user_login
3495-
* user_email
3496-
* registered
3497-
* active
3498-
* activation_key
3499-
3500-
These fields are optionally available:
3501-
3502-
* domain
3503-
* path
3504-
* title
3505-
* activated
3506-
* meta
3507-
3508-
**EXAMPLES**
3509-
3510-
# List signup IDs.
3511-
$ wp signup list --field=signup_id
3512-
1
3513-
3514-
# List all signups.
3515-
$ wp signup list
3516-
+-----------+------------+---------------------+---------------------+--------+------------------+
3517-
| signup_id | user_login | user_email | registered | active | activation_key |
3518-
+-----------+------------+---------------------+---------------------+--------+------------------+
3519-
| 1 | bobuser | [email protected] | 2024-03-13 05:46:53 | 1 | 7320b2f009266618 |
3520-
| 2 | johndoe | [email protected] | 2024-03-13 06:24:44 | 0 | 9068d859186cd0b5 |
3521-
+-----------+------------+---------------------+---------------------+--------+------------------+
3522-
3523-
3524-
35253347
### wp site
35263348

35273349
Creates, deletes, empties, moderates, and lists one or more sites on a multisite installation.
@@ -6472,6 +6294,186 @@ wp user set-role <user> [<role>]
64726294

64736295

64746296

6297+
### wp user signup
6298+
6299+
Manages signups on a multisite installation.
6300+
6301+
~~~
6302+
wp user signup
6303+
~~~
6304+
6305+
**EXAMPLES**
6306+
6307+
# List signups.
6308+
$ wp user signup list
6309+
+-----------+------------+---------------------+---------------------+--------+------------------+
6310+
| signup_id | user_login | user_email | registered | active | activation_key |
6311+
+-----------+------------+---------------------+---------------------+--------+------------------+
6312+
| 1 | bobuser | [email protected] | 2024-03-13 05:46:53 | 1 | 7320b2f009266618 |
6313+
| 2 | johndoe | [email protected] | 2024-03-13 06:24:44 | 0 | 9068d859186cd0b5 |
6314+
+-----------+------------+---------------------+---------------------+--------+------------------+
6315+
6316+
# Activate signup.
6317+
$ wp user signup activate 2
6318+
Success: Signup 2 activated. Password: bZFSGsfzb9xs
6319+
6320+
# Delete signup.
6321+
$ wp user signup delete 3
6322+
Success: Signup 3 deleted.
6323+
6324+
6325+
6326+
6327+
6328+
### wp user signup activate
6329+
6330+
Activates one or more signups.
6331+
6332+
~~~
6333+
wp user signup activate <signup>...
6334+
~~~
6335+
6336+
**OPTIONS**
6337+
6338+
<signup>...
6339+
The signup ID, user login, user email, or activation key of the signup(s) to activate.
6340+
6341+
**EXAMPLES**
6342+
6343+
# Activate signup.
6344+
$ wp user signup activate 2
6345+
Success: Signup 2 activated. Password: bZFSGsfzb9xs
6346+
6347+
6348+
6349+
### wp user signup delete
6350+
6351+
Deletes one or more signups.
6352+
6353+
~~~
6354+
wp user signup delete <signup>...
6355+
~~~
6356+
6357+
**OPTIONS**
6358+
6359+
<signup>...
6360+
The signup ID, user login, user email, or activation key of the signup(s) to delete.
6361+
6362+
**EXAMPLES**
6363+
6364+
# Delete signup.
6365+
$ wp user signup delete 3
6366+
Success: Signup 3 deleted.
6367+
6368+
6369+
6370+
### wp user signup get
6371+
6372+
Gets details about a signup.
6373+
6374+
~~~
6375+
wp user signup get <signup> [--field=<field>] [--fields=<fields>] [--format=<format>]
6376+
~~~
6377+
6378+
**OPTIONS**
6379+
6380+
<signup>
6381+
The signup ID, user login, user email, or activation key.
6382+
6383+
[--field=<field>]
6384+
Instead of returning the whole signup, returns the value of a single field.
6385+
6386+
[--fields=<fields>]
6387+
Limit the output to specific fields. Defaults to all fields.
6388+
6389+
[--format=<format>]
6390+
Render output in a particular format.
6391+
---
6392+
default: table
6393+
options:
6394+
- table
6395+
- csv
6396+
- json
6397+
- yaml
6398+
---
6399+
6400+
**EXAMPLES**
6401+
6402+
# Get signup.
6403+
$ wp user signup get 1 --field=user_login
6404+
bobuser
6405+
6406+
# Get signup and export to JSON file.
6407+
$ wp user signup get bobuser --format=json > bobuser.json
6408+
6409+
6410+
6411+
### wp user signup list
6412+
6413+
Lists signups.
6414+
6415+
~~~
6416+
wp user signup list [--<field>=<value>] [--field=<field>] [--fields=<fields>] [--format=<format>]
6417+
~~~
6418+
6419+
[--<field>=<value>]
6420+
Filter the list by a specific field.
6421+
6422+
[--field=<field>]
6423+
Prints the value of a single field for each signup.
6424+
6425+
[--fields=<fields>]
6426+
Limit the output to specific object fields.
6427+
6428+
[--format=<format>]
6429+
Render output in a particular format.
6430+
---
6431+
default: table
6432+
options:
6433+
- table
6434+
- csv
6435+
- ids
6436+
- json
6437+
- count
6438+
- yaml
6439+
---
6440+
6441+
**AVAILABLE FIELDS**
6442+
6443+
These fields will be displayed by default for each signup:
6444+
6445+
* signup_id
6446+
* user_login
6447+
* user_email
6448+
* registered
6449+
* active
6450+
* activation_key
6451+
6452+
These fields are optionally available:
6453+
6454+
* domain
6455+
* path
6456+
* title
6457+
* activated
6458+
* meta
6459+
6460+
**EXAMPLES**
6461+
6462+
# List signup IDs.
6463+
$ wp user signup list --field=signup_id
6464+
1
6465+
6466+
# List all signups.
6467+
$ wp user signup list
6468+
+-----------+------------+---------------------+---------------------+--------+------------------+
6469+
| signup_id | user_login | user_email | registered | active | activation_key |
6470+
+-----------+------------+---------------------+---------------------+--------+------------------+
6471+
| 1 | bobuser | [email protected] | 2024-03-13 05:46:53 | 1 | 7320b2f009266618 |
6472+
| 2 | johndoe | [email protected] | 2024-03-13 06:24:44 | 0 | 9068d859186cd0b5 |
6473+
+-----------+------------+---------------------+---------------------+--------+------------------+
6474+
6475+
6476+
64756477
### wp user spam
64766478

64776479
Marks one or more users as spam on multisite.

composer.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -121,11 +121,6 @@
121121
"post-type",
122122
"post-type get",
123123
"post-type list",
124-
"signup",
125-
"signup activate",
126-
"signup delete",
127-
"signup get",
128-
"signup list",
129124
"site",
130125
"site activate",
131126
"site archive",
@@ -203,6 +198,11 @@
203198
"user session destroy",
204199
"user session list",
205200
"user set-role",
201+
"user signup",
202+
"user signup activate",
203+
"user signup delete",
204+
"user signup get",
205+
"user signup list",
206206
"user spam",
207207
"user term",
208208
"user term add",

0 commit comments

Comments
 (0)