Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add --slug=<site> as an available parameter to wp site commands #416

Merged
merged 17 commits into from
Sep 18, 2023
Merged

Add --slug=<site> as an available parameter to wp site commands #416

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
17 commits
Select commit Hold shift + click to select a range
8ab1c8f
Add slug as an available parameter to 'wp site private' command
tubiz Aug 24, 2023
7a68076
Add slug as an available parameter to 'wp site public' command
tubiz Aug 24, 2023
8e2e4ee
Add slug as an available parameter to 'wp site unmature' command
tubiz Aug 24, 2023
d95c906
Add slug as an available parameter to 'wp site mature' command
tubiz Aug 24, 2023
956f320
Add slug as an available parameter to 'wp site unspam' command
tubiz Aug 24, 2023
635144b
Add slug as an available parameter to 'wp site spam' command
tubiz Aug 24, 2023
95929a8
Add slug as an available parameter to 'wp site deactivate' command
tubiz Aug 24, 2023
8ac91f5
Add slug as an available parameter to 'wp site activate' command
tubiz Aug 24, 2023
83f5e7a
Add slug as an available parameter to 'wp site unarchive' command
tubiz Aug 24, 2023
67a70ea
Add slug as an available parameter to 'wp site archive' command
tubiz Aug 24, 2023
7e25c14
Add feature tests
tubiz Aug 24, 2023
c276316
New get_site_by_slug() method to fetch site by slug
tubiz Aug 24, 2023
a49c5c6
Get site by slug using get_site_by_slug()
tubiz Aug 24, 2023
59a3f7a
Refactoring, add new get_sites_ids() and check_site_ids_and_slug() me…
tubiz Sep 15, 2023
1de7d6f
Add feature test to check if the blog ID or slug is provided.
tubiz Sep 15, 2023
24d2cbe
Prevent `<id>...` and `--slug=<slug>` from being used at the same time
danielbachhuber Sep 18, 2023
26efe8f
Regenerate `README.md`
danielbachhuber Sep 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
118 changes: 86 additions & 32 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3271,39 +3271,51 @@ wp site
Activates one or more sites.

~~~
wp site activate <id>...
wp site activate [<id>...] [--slug=<slug>]
~~~

**OPTIONS**

<id>...
One or more IDs of sites to activate.
[<id>...]
One or more IDs of sites to activate. If not provided, you must set the --slug parameter.

[--slug=<slug>]
Path of the site to be activated. Subdomain on subdomain installs, directory on subdirectory installs.

**EXAMPLES**

$ wp site activate 123
Success: Site 123 activated.

$ wp site activate --slug=demo
Success: Site 123 marked as activated.



### wp site archive

Archives one or more sites.

~~~
wp site archive <id>...
wp site archive [<id>...] [--slug=<slug>]
~~~

**OPTIONS**

<id>...
One or more IDs of sites to archive.
[<id>...]
One or more IDs of sites to archive. If not provided, you must set the --slug parameter.

[--slug=<slug>]
Path of the site to archive. Subdomain on subdomain installs, directory on subdirectory installs.

**EXAMPLES**

$ wp site archive 123
Success: Site 123 archived.

$ wp site archive --slug=demo
Success: Site 123 archived.



### wp site create
Expand Down Expand Up @@ -3346,19 +3358,25 @@ wp site create --slug=<slug> [--title=<title>] [--email=<email>] [--network_id=<
Deactivates one or more sites.

~~~
wp site deactivate <id>...
wp site deactivate [<id>...] [--slug=<slug>]
~~~

**OPTIONS**

<id>...
One or more IDs of sites to deactivate.
[<id>...]
One or more IDs of sites to deactivate. If not provided, you must set the --slug parameter.

[--slug=<slug>]
Path of the site to be deactivated. Subdomain on subdomain installs, directory on subdirectory installs.

**EXAMPLES**

$ wp site deactivate 123
Success: Site 123 deactivated.

$ wp site deactivate --slug=demo
Success: Site 123 marked as deactivated.



### wp site delete
Expand All @@ -3375,7 +3393,7 @@ wp site delete [<site-id>] [--slug=<slug>] [--yes] [--keep-tables]
The id of the site to delete. If not provided, you must set the --slug parameter.

[--slug=<slug>]
Path of the blog to be deleted. Subdomain on subdomain installs, directory on subdirectory installs.
Path of the site to be deleted. Subdomain on subdomain installs, directory on subdirectory installs.

[--yes]
Answer yes to the confirmation message.
Expand Down Expand Up @@ -3508,19 +3526,25 @@ These fields are optionally available:
Sets one or more sites as mature.

~~~
wp site mature <id>...
wp site mature [<id>...] [--slug=<slug>]
~~~

**OPTIONS**

<id>...
One or more IDs of sites to set as mature.
[<id>...]
One or more IDs of sites to set as mature. If not provided, you must set the --slug parameter.

[--slug=<slug>]
Path of the site to be set as mature. Subdomain on subdomain installs, directory on subdirectory installs.

**EXAMPLES**

$ wp site mature 123
Success: Site 123 marked as mature.

$ wp site mature --slug=demo
Success: Site 123 marked as mature.



### wp site option
Expand Down Expand Up @@ -3558,53 +3582,68 @@ wp site option
Sets one or more sites as private.

~~~
wp site private <id>...
wp site private [<id>...] [--slug=<slug>]
~~~

**OPTIONS**

<id>...
One or more IDs of sites to set as private.
[<id>...]
One or more IDs of sites to set as private. If not provided, you must set the --slug parameter.

[--slug=<slug>]
Path of the site to be set as private. Subdomain on subdomain installs, directory on subdirectory installs.

**EXAMPLES**

$ wp site private 123
Success: Site 123 marked as private.

$ wp site private --slug=demo
Success: Site 123 marked as private.



### wp site public

Sets one or more sites as public.

~~~
wp site public <id>...
wp site public [<id>...] [--slug=<slug>]
~~~

**OPTIONS**

<id>...
One or more IDs of sites to set as public.
[<id>...]
One or more IDs of sites to set as public. If not provided, you must set the --slug parameter.

[--slug=<slug>]
Path of the site to be set as public. Subdomain on subdomain installs, directory on subdirectory installs.

**EXAMPLES**

$ wp site public 123
Success: Site 123 marked as public.

$ wp site public --slug=demo
Success: Site 123 marked as public.



### wp site spam

Marks one or more sites as spam.

~~~
wp site spam <id>...
wp site spam [<id>...] [--slug=<slug>]
~~~

**OPTIONS**

<id>...
One or more IDs of sites to be marked as spam.
[<id>...]
One or more IDs of sites to be marked as spam. If not provided, you must set the --slug parameter.

[--slug=<slug>]
Path of the site to be marked as spam. Subdomain on subdomain installs, directory on subdirectory installs.

**EXAMPLES**

Expand All @@ -3618,37 +3657,49 @@ wp site spam <id>...
Unarchives one or more sites.

~~~
wp site unarchive <id>...
wp site unarchive [<id>...] [--slug=<slug>]
~~~

**OPTIONS**

<id>...
One or more IDs of sites to unarchive.
[<id>...]
One or more IDs of sites to unarchive. If not provided, you must set the --slug parameter.

[--slug=<slug>]
Path of the site to unarchive. Subdomain on subdomain installs, directory on subdirectory installs.

**EXAMPLES**

$ wp site unarchive 123
Success: Site 123 unarchived.

$ wp site unarchive --slug=demo
Success: Site 123 unarchived.



### wp site unmature

Sets one or more sites as immature.

~~~
wp site unmature <id>...
wp site unmature [<id>...] [--slug=<slug>]
~~~

**OPTIONS**

<id>...
One or more IDs of sites to set as unmature.
[<id>...]
One or more IDs of sites to set as unmature. If not provided, you must set the --slug parameter.

[--slug=<slug>]
Path of the site to be set as unmature. Subdomain on subdomain installs, directory on subdirectory installs.

**EXAMPLES**

$ wp site general 123
$ wp site unmature 123
Success: Site 123 marked as unmature.

$ wp site unmature --slug=demo
Success: Site 123 marked as unmature.


Expand All @@ -3658,13 +3709,16 @@ wp site unmature <id>...
Removes one or more sites from spam.

~~~
wp site unspam <id>...
wp site unspam [<id>...] [--slug=<slug>]
~~~

**OPTIONS**

<id>...
One or more IDs of sites to remove from spam.
[<id>...]
One or more IDs of sites to remove from spam. If not provided, you must set the --slug parameter.

[--slug=<slug>]
Path of the site to be removed from spam. Subdomain on subdomain installs, directory on subdirectory installs.

**EXAMPLES**

Expand Down
Loading