Cmdlets for WordPress

Build 24.0.9060

Establishing a Connection

With the CData Cmdlets users can install a data module, set the connection properties, and start scripting. This section provides examples of using our Wordpress Cmdlets with native PowerShell cmdlets, like the CSV import and export cmdlets.

Installing and Connecting

If you have PSGet, installing the cmdlets can be accomplished from the PowerShell Gallery with the following command. You can also obtain a setup from the CData site. 

Install-Module WordpressCmdlets

The following line is then added to your profile, loading the cmdlets on the next session: 

Import-Module WordpressCmdlets;

You can then use the Connect-Wordpress cmdlet to create a connection object that can be passed to other cmdlets: 

$conn = Connect-Wordpress -Url 'http://www.yourwordpresshost.com' -User 'yourUserName' -Password 'yourPassword'

Connecting to WordPress

At this time, CData Cmdlets PowerShell Module for WordPress only supports connecting to self-hosted WordPress instances. To connect to data, supply the Url to your wordpress site, and then authenticate as described below.

Supply the URL in its full form. For example, if your site is hosted at http://localhost/wp/wordpress', the URL should be http://localhost/wp/wordpress, and not 'htpp://localhost'. Failure to supply the URL in its full form results in a 'site not found' error.

WordPress supports two types of authentication:

  • Basic authentication, which is recommended for use in a testing environment; and
  • OAuth 2.0 authentication, which supports browser-based access from a Desktop application, Web application, or Headless Machine.

Basic Authentication

Basic authentication is recommended for testing environments only.

Before you configure WordPress to use Basic Authentication:

  • Ensure that your WordPress login has adminstrative privileges.
  • Know what version of WordPress is running at the local host. (WordPress 4.7 and later support the WordPress REST API natively; earlier versions require the use of a Basic Authentication plug-in to secure access to the REST API.)

To configure Basic Authentication:

  1. Log into your WordPress host.
  2. If you are running an earlier WordPress version than 4.7, install the REST API plugin.
  3. Install the Basic Authentication plugin.
  4. To create custom taxonomies, install the Simple Taxonomy Refreshed
    If you prefer installing the plugins manually, extract the compressed folders to the wp-content\plugins folder and then enable the plugins via the WordPress admin interface.
  5. Set the following connection properties:
    • AuthScheme: Basic.
    • Url: Your WordPress URL.
    • User: Your username.
    • Password: Your password.

You are now ready to connect.

OAuth 2.0 Authentication

For all non-testing environments, WordPress supports OAuth authentication only. To enable this authentication from all OAuth flows, you must set AuthScheme to OAuth, and you must create a custom OAuth application.

The following subsections describe how to authenticate to WordPress from three common authentication flows. For information about how to create a custom OAuth application, see Creating a Custom OAuth Application. For a complete list of connection string properties available in WordPress, see Connection.

Desktop Applications

To authenticate with the credentials for a custom OAuth application, you must get and refresh the OAuth access token. After you do that, you are ready to connect.

Get and refresh the OAuth access token:

  • InitiateOAuth: GETANDREFRESH. Used to automatically get and refresh the OAuthAccessToken.
  • OAuthClientId: The client Id assigned when you registered your application.
  • OAuthClientSecret: The client secret that was assigned when you registered your application.
  • CallbackURL: The redirect URI that was defined when you registered your application.

When you connect, the cmdlet opens WordPress's OAuth endpoint in your default browser. Log in and grant permissions to the application.

When the access token expires, the cmdlet refreshes it automatically.

Automatic refresh of the OAuth access token:

To have the cmdlet automatically refresh the OAuth access token, do the following:

  1. Before connecting to data for the first time, set the following connection parameters:
    • InitiateOAuth: REFRESH.
    • OAuthClientId: The client Id in your application settings.
    • OAuthClientSecret: The client secret in your application settings.
    • OAuthAccessToken: The access token returned by GetOAuthAccessToken.
    • OAuthSettingsLocation: The path where you want the cmdlet to save the OAuth values, which persist across connections.
  2. On subsequent data connections, set the following:
    • InitiateOAuth
    • OAuthSettingsLocation

Headless Machines

If you need to log in to a resource that resides on a headless machine, you must authenticate on another device that has an internet browser. You can do this in either of the following ways:

  • Option 1: Obtain the OAuthVerifier value.
  • Option 2: Install the cmdlet on a machine with an internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow.

After you execute either Option 1 or Option 2, configure the driver to automatically refresh the access token on the headless machine.

Option 1: Obtaining and Exchanging a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL. Do the following:

  1. Authenticate from the machine with an internet browser, and obtain the OAuthVerifier connection property.

    Set the following properties:

    • InitiateOAuth: OFF.
    • OAuthClientId: The client Id assigned when you registered your application.
    • OAuthClientSecret: The client secret assigned when you registered your application.

  2. Call the GetOAuthAuthorizationURL stored procedure. The stored procedure returns the CallbackURL established when the custom OAuth application was registered. (See Creating a Custom OAuth Application.)

    Copy this URL and paste it into a new browser tab.

  3. Log in and grant permissions to the cmdlet. The OAuth application redirects you the redirect URI, with a parameter called code appended. Note the value of this parameter; you will need it later, to configure the OAuthVerifier connection property.

  4. Exchange the OAuth verifier code for OAuth refresh and access tokens. On the headless machine, set the following connection properties to obtain the OAuth authentication values:

    • InitiateOAuth: REFRESH.
    • OAuthVerifier: The noted verifier code (the value of the code parameter in the redirect URI).
    • OAuthSettingsLocation: Persist the encrypted OAuth authentication values to the specified file.
    • OAuthClientId: The client Id in your custom OAuth application settings.
    • OAuthClientSecret: The client secret in the custom OAuth application settings.

  5. Test the connection to generate the OAuth settings file.

  6. After you re-set the following properties, you are ready to connect:

    • InitiateOAuth: REFRESH.
    • OAuthSettingsLocation: The file containing the encrypted OAuth authentication values. To enable the automatic refreshing of the access token, be sure that this file gives read and write permissions to the cmdlet.
    • OAuthClientId: The client Id assigned when you registered your application.
    • OAuthClientSecret: The client secret assigned when you registered your application.

Option 2: Transferring OAuth Settings

Prior to connecting on a headless machine, you must install and create a connection with the driver on a device that supports an internet browser. Set the connection properties as described above in "Desktop Applications".

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the path specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Test the connection to generate the OAuth settings file, then copy the OAuth settings file to your headless machine.

To connect to data via the headless machine, set the following connection properties:

  • InitiateOAuth: REFRESH
  • OAuthSettingsLocation: The path to the OAuth settings file you copied from the machine with the browser. To enable automatic refreshing of the access token, ensure that this file gives read and write permissions to the cmdlet.
  • OAuthClientId: The client Id assigned when you registered your custom OAuth application.
  • OAuthClientSecret: The client secret assigned when you registered your custom OAuth application.

Retrieving Data

The Select-Wordpress cmdlet provides a native PowerShell interface for retrieving data: 

$results = Select-Wordpress -Connection $conn -Table "Categories" -Columns @("Id, Name") -Where "Id='1668776136772254'"
The Invoke-Wordpress cmdlet provides an SQL interface. This cmdlet can be used to execute an SQL query via the Query parameter.

Piping Cmdlet Output

The cmdlets return row objects to the pipeline one row at a time. The following line exports results to a CSV file: 

Select-Wordpress -Connection $conn -Table Categories -Where "Id = '1668776136772254'" | Select -Property * -ExcludeProperty Connection,Table,Columns | Export-Csv -Path c:\myCategoriesData.csv -NoTypeInformation

You will notice that we piped the results from Select-Wordpress into a Select-Object cmdlet and excluded some properties before piping them into an Export-CSV cmdlet. We do this because the CData Cmdlets append Connection, Table, and Columns information onto each row object in the result set, and we do not necessarily want that information in our CSV file.

However, this makes it easy to pipe the output of one cmdlet to another. The following is an example of converting a result set to JSON: 

 
PS C:\> $conn  = Connect-Wordpress -Url 'http://www.yourwordpresshost.com' -User 'yourUserName' -Password 'yourPassword'
PS C:\> $row = Select-Wordpress -Connection $conn -Table "Categories" -Columns (Id, Name) -Where "Id = '1668776136772254'" | select -first 1
PS C:\> $row | ConvertTo-Json
{
  "Connection":  {

  },
  "Table":  "Categories",
  "Columns":  [

  ],
  "Id":  "MyId",
  "Name":  "MyName"
}

Deleting Data

The following line deletes any records that match the criteria: 

Select-Wordpress -Connection $conn -Table Categories -Where "Id = '1668776136772254'" | Remove-Wordpress

Modifying Data

The cmdlets make data transformation easy as well as data cleansing. The following example loads data from a CSV file into WordPress, checking first whether a record already exists and needs to be updated instead of inserted. 

Import-Csv -Path C:\MyCategoriesUpdates.csv | %{
  $record = Select-Wordpress -Connection $conn -Table Categories -Where ("Id = `'"+$_.Id+"`'")
  if($record){
    Update-Wordpress -Connection $conn -Table Categories -Columns @("Id","Name") -Values @($_.Id, $_.Name) -Where "Id  = `'$_.Id`'"
  }else{
    Add-Wordpress -Connection $conn -Table Categories -Columns @("Id","Name") -Values @($_.Id, $_.Name)
  }
}

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060