Ready to get started?

Learn more about the CData ODBC Driver for WooCommerce or download a free trial:

Download Now

Natively Connect to WooCommerce Data in PHP

The CData ODBC driver for WooCommerce enables you to create PHP applications with connectivity to WooCommerce data. Leverage the native support for ODBC in PHP.

Drop the CData ODBC Driver for WooCommerce into your LAMP or WAMP stack to build WooCommerce-connected Web applications. This article shows how to use PHP's ODBC built-in functions to connect to WooCommerce data, execute queries, and output the results.

Configure a DSN

If you have not already, first specify connection properties in an ODBC DSN (data source name). This is the last step of the driver installation. You can use the Microsoft ODBC Data Source Administrator to create and configure ODBC DSNs.

WooCommerce supports the following authentication methods: one-legged OAuth1.0 Authentication and standard OAuth2.0 Authentication.

Connecting using one-legged OAuth 1.0 Authentication

Specify the following properties (NOTE: the below credentials are generated from &service; settings page and should not be confused with the credentials generated by using WordPress OAuth2.0 plugin):

  • ConsumerKey
  • ConsumerSecret

Connecting using WordPress OAuth 2.0 Authentication

After having configured the plugin, you may connect to WooCommerce by providing the following connection properties:

  • OAuthClientId
  • OAuthClientSecret
  • CallbackURL
  • InitiateOAuth - Set this to either GETANDREFRESH or REFRESH

In either case, you will need to set the Url property to the URL of the WooCommerce instance.

Establish a Connection

Open the connection to WooCommerce by calling the odbc_connect or odbc_pconnect methods. To close connections, use odbc_close or odbc_close_all.

$conn = odbc_connect("CData ODBC WooCommerce Source","user","password");

Connections opened with odbc_connect are closed when the script ends. Connections opened with the odbc_pconnect method are still open after the script ends. This enables other scripts to share that connection when they connect with the same credentials. By sharing connections among your scripts, you can save system resources, and queries execute faster.

$conn = odbc_pconnect("CData ODBC WooCommerce Source","user","password"); ... odbc_close($conn); //persistent connection must be closed explicitly

Create Prepared Statements

Create prepared statements and parameterized queries with the odbc_prepare function.

$query = odbc_prepare($conn, "SELECT * FROM Orders WHERE ParentId = ?");

Execute Queries

Execute prepared statements with odbc_execute.

$conn = odbc_connect("CData ODBC WooCommerce Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Orders WHERE ParentId = ?"); $success = odbc_execute($query, array('3'));

Execute nonparameterized queries with odbc_exec.

$conn = odbc_connect("CData ODBC WooCommerce Source","user","password"); $query = odbc_exec($conn, "SELECT ParentId, Total FROM Orders WHERE ParentId = '3'");

Process Results

Access a row in the result set as an array with the odbc_fetch_array function.

$conn = odbc_connect("CData ODBC WooCommerce data Source","user","password"); $query = odbc_exec($conn, "SELECT ParentId, Total FROM Orders WHERE ParentId = '3'"); while($row = odbc_fetch_array($query)){ echo $row["ParentId"] . "\n"; }

Display the result set in an HTML table with the odbc_result_all function.

$conn = odbc_connect("CData ODBC WooCommerce data Source","user","password"); $query = odbc_prepare($conn, "SELECT * FROM Orders WHERE ParentId = ?"); $success = odbc_execute($query, array('3')); if($success) odbc_result_all($query);

More Example Queries

You will find complete information on the driver's supported SQL in the help documentation. The code examples above are WooCommerce-specific adaptations of the PHP community documentation for all ODBC functions.