@@ -8202,6 +8202,291 @@ wp user meta update <user> <key> <value> [--format=<format>]
82028202
82038203
82048204
8205+ ### wp user privacy-request
8206+
8207+ Manages user privacy requests (GDPR personal data export and erasure).
8208+
8209+ ~~~
8210+ wp user privacy-request
8211+ ~~~
8212+
8213+ ** EXAMPLES**
8214+
8215+ # List all privacy requests.
8216+ $ wp user privacy-request list
8217+ +----+-------------------+----------------------+-------------------+--------------------+
8218+ | ID | user_email | action_name | status | created_timestamp |
8219+ +----+-------------------+----------------------+-------------------+--------------------+
8220+ | 1 | bob@example.com | export_personal_data | request-pending | 1713779524 |
8221+ +----+-------------------+----------------------+-------------------+--------------------+
8222+
8223+ # Create a new data export request.
8224+ $ wp user privacy-request create bob@example.com export_personal_data
8225+ Success: Created privacy request 1.
8226+
8227+ # Erase personal data for request 1.
8228+ $ wp user privacy-request erase 1
8229+ Success: Erased personal data for request 1.
8230+
8231+ # Export personal data for request 1.
8232+ $ wp user privacy-request export 1
8233+ Success: Exported personal data to: /var/www/html/wp-content/uploads/wp-personal-data-exports/wp-personal-data-export-bob-example-com-1.zip
8234+
8235+ # Mark request 1 as complete.
8236+ $ wp user privacy-request complete 1
8237+ Success: Completed 1 of 1 privacy requests.
8238+
8239+ # Delete request 1.
8240+ $ wp user privacy-request delete 1
8241+ Success: Deleted 1 of 1 privacy requests.
8242+
8243+
8244+
8245+
8246+
8247+ ### wp user privacy-request complete
8248+
8249+ Marks one or more privacy requests as completed.
8250+
8251+ ~~~
8252+ wp user privacy-request complete <request-id>...
8253+ ~~~
8254+
8255+ ** OPTIONS**
8256+
8257+ <request-id>...
8258+ One or more IDs of the privacy requests to complete.
8259+
8260+ ** EXAMPLES**
8261+
8262+ # Mark request 1 as completed.
8263+ $ wp user privacy-request complete 1
8264+ Privacy request 1 completed.
8265+ Success: Completed 1 of 1 privacy requests.
8266+
8267+ # Mark multiple requests as completed.
8268+ $ wp user privacy-request complete 1 2
8269+ Privacy request 1 completed.
8270+ Privacy request 2 completed.
8271+ Success: Completed 2 of 2 privacy requests.
8272+
8273+
8274+
8275+ ### wp user privacy-request create
8276+
8277+ Creates a privacy request for a user.
8278+
8279+ ~~~
8280+ wp user privacy-request create <email> <action-type> [--status=<status>] [--send-email] [--porcelain]
8281+ ~~~
8282+
8283+ ** OPTIONS**
8284+
8285+ <email>
8286+ The email address of the user to create the request for.
8287+
8288+ <action-type>
8289+ The type of personal data request.
8290+ ---
8291+ options:
8292+ - export_personal_data
8293+ - remove_personal_data
8294+ ---
8295+
8296+ [--status=<status>]
8297+ The initial status of the request.
8298+ ---
8299+ default: pending
8300+ options:
8301+ - pending
8302+ - confirmed
8303+ ---
8304+
8305+ [--send-email]
8306+ If set, sends a confirmation email to the user.
8307+
8308+ [--porcelain]
8309+ Output just the new request ID.
8310+
8311+ ** EXAMPLES**
8312+
8313+ # Create a new data export request with pending status.
8314+ $ wp user privacy-request create bob@example.com export_personal_data
8315+ Success: Created privacy request 1.
8316+
8317+ # Create a confirmed data erasure request.
8318+ $ wp user privacy-request create bob@example.com remove_personal_data --status=confirmed
8319+ Success: Created privacy request 2.
8320+
8321+ # Get just the new request ID.
8322+ $ wp user privacy-request create bob@example.com export_personal_data --porcelain
8323+ 3
8324+
8325+
8326+
8327+ ### wp user privacy-request delete
8328+
8329+ Deletes one or more privacy requests.
8330+
8331+ ~~~
8332+ wp user privacy-request delete <request-id>...
8333+ ~~~
8334+
8335+ ** OPTIONS**
8336+
8337+ <request-id>...
8338+ One or more IDs of the privacy requests to delete.
8339+
8340+ ** EXAMPLES**
8341+
8342+ # Delete privacy request 1.
8343+ $ wp user privacy-request delete 1
8344+ Privacy request 1 deleted.
8345+ Success: Deleted 1 of 1 privacy requests.
8346+
8347+ # Delete multiple privacy requests.
8348+ $ wp user privacy-request delete 1 2 3
8349+ Privacy request 1 deleted.
8350+ Privacy request 2 deleted.
8351+ Privacy request 3 deleted.
8352+ Success: Deleted 3 of 3 privacy requests.
8353+
8354+
8355+
8356+ ### wp user privacy-request erase
8357+
8358+ Erases personal data for a given privacy request.
8359+
8360+ ~~~
8361+ wp user privacy-request erase <request-id>
8362+ ~~~
8363+
8364+ Runs all registered data erasers for the email address associated with the
8365+ request, then marks the request as completed.
8366+
8367+ ** OPTIONS**
8368+
8369+ <request-id>
8370+ The ID of the remove_personal_data privacy request to process.
8371+
8372+ ** EXAMPLES**
8373+
8374+ # Erase personal data for request 1.
8375+ $ wp user privacy-request erase 1
8376+ Success: Erased personal data for request 1.
8377+
8378+
8379+
8380+ ### wp user privacy-request export
8381+
8382+ Exports personal data for a given privacy request.
8383+
8384+ ~~~
8385+ wp user privacy-request export <request-id>
8386+ ~~~
8387+
8388+ Runs all registered data exporters for the email address associated with
8389+ the request, generates a ZIP file containing the data, then marks the
8390+ request as completed.
8391+
8392+ ** OPTIONS**
8393+
8394+ <request-id>
8395+ The ID of the export_personal_data privacy request to process.
8396+
8397+ ** EXAMPLES**
8398+
8399+ # Export personal data for request 1.
8400+ $ wp user privacy-request export 1
8401+ Success: Exported personal data to: /var/www/html/wp-content/uploads/wp-personal-data-exports/wp-personal-data-export-bob-example-com-1.zip
8402+
8403+
8404+
8405+ ### wp user privacy-request list
8406+
8407+ Lists privacy requests.
8408+
8409+ ~~~
8410+ wp user privacy-request list [--action-type=<action-type>] [--status=<status>] [--field=<field>] [--fields=<fields>] [--format=<format>]
8411+ ~~~
8412+
8413+ ** OPTIONS**
8414+
8415+ [--action-type=<action-type>]
8416+ Filter the list by action type.
8417+ ---
8418+ options:
8419+ - export_personal_data
8420+ - remove_personal_data
8421+ ---
8422+
8423+ [--status=<status>]
8424+ Filter the list by request status.
8425+ ---
8426+ options:
8427+ - request-pending
8428+ - request-confirmed
8429+ - request-failed
8430+ - request-completed
8431+ ---
8432+
8433+ [--field=<field>]
8434+ Prints the value of a single field for each request.
8435+
8436+ [--fields=<fields>]
8437+ Limit the output to specific object fields.
8438+
8439+ [--format=<format>]
8440+ Render output in a particular format.
8441+ ---
8442+ default: table
8443+ options:
8444+ - table
8445+ - csv
8446+ - ids
8447+ - json
8448+ - count
8449+ - yaml
8450+ ---
8451+
8452+ ** AVAILABLE FIELDS**
8453+
8454+ These fields will be displayed by default for each request:
8455+
8456+ * ID
8457+ * user_email
8458+ * action_name
8459+ * status
8460+ * created_timestamp
8461+
8462+ These fields are optionally available:
8463+
8464+ * user_id
8465+ * confirmed_timestamp
8466+ * completed_timestamp
8467+
8468+ ** EXAMPLES**
8469+
8470+ # List all privacy requests.
8471+ $ wp user privacy-request list
8472+ +----+-------------------+----------------------+-------------------+--------------------+
8473+ | ID | user_email | action_name | status | created_timestamp |
8474+ +----+-------------------+----------------------+-------------------+--------------------+
8475+ | 1 | bob@example.com | export_personal_data | request-pending | 1713779524 |
8476+ +----+-------------------+----------------------+-------------------+--------------------+
8477+
8478+ # List only export requests.
8479+ $ wp user privacy-request list --action-type=export_personal_data
8480+
8481+ # List only completed requests.
8482+ $ wp user privacy-request list --status=request-completed
8483+
8484+ # List request IDs only.
8485+ $ wp user privacy-request list --format=ids
8486+ 1 2
8487+
8488+
8489+
82058490### wp user remove-cap
82068491
82078492Removes a user's capability.
0 commit comments