Skip to content
Snippets Groups Projects
To learn more about this project, read the wiki.
README.md 2.69 KiB

WP-CLI integration for CiviCRM

wp civicrm api

Command for accessing the CiviCRM API. Syntax is identical to drush cvap.

wp civicrm cache-clear

Command for accessing clearing cache. Equivilant of running civicrm/admin/setting/updateConfigBackend&reset=1.

wp civicrm enable-debug

Command for to turn debug on.

wp civicrm disable-debug

Command for to turn debug off.

wp civicrm member-records

Run the CiviMember UpdateMembershipRecord cron (civicrm member-records).

wp civicrm process-mail-queue

Process pending CiviMail mailing jobs.

Example: wp civicrm process-mail-queue -u admin

wp civicrm rest

Rest interface for accessing CiviCRM APIs. It can return xml or json formatted data.

wp civicrm restore

Restore CiviCRM codebase and database back from the specified backup directory.

wp civicrm sql-conf

Show CiviCRM database connection details.

wp civicrm sql-connect

A string which connects to the CiviCRM database.

wp civicrm sql-cli

Quickly enter the mysql command line.

wp civicrm sql-dump

Prints the whole CiviCRM database to STDOUT or save to a file.

wp civicrm sql-query

Usage: wp civicrm sql-query <query> <options>...

<query> is a SQL statement which can alternatively be passed via STDIN. Any additional arguments are passed to the mysql command directly.

wp civicrm update-cfg