Installation guide for 'cpd-search' plugin


This guide is intended for agents / developers who wish to install the cpd-search plugin to their wordpress site and have a working commercial property search facility of either their own properties (current instructions), full UK wide search or a customised search of specific areas for specific property types. see our API docs for more information on customising the plugin.

To get a working version of the 'cpd'search' plugin on your wordpress site you will need

Follow the instructions below

Download / Install 'cpd-search' plugin

Two recommended ways to download / install the cpd-search plugin

  1. Go to wp-admin / plugins and 'add new' and add the keyword for 'cpd search'.
  2. Download the files directly here and install manually.

Get CPD token


Download of our wordpress plugin is FREE but in order for the plugin to work you will need a token from cpd which will allow connection to our database.

We have two subscription levels which will let agents display

To request a token please contact us.

Configure the plugin / Add token

Usually your token will be emailed to your contact address.

Go to the wp-admin settings for the cpd-search-plugin (see screenshot below) then copy and paste the cpd-token into place and save. If configured correctly there should be a message like 'server connection successful'

Copy in .php pages & .js files/ Install simple basis theme

There are a set of .php pages and .js files which need to be present in your wordpress site theme for the plugin to work.

These files are available in the cpd own theme 'simplebasis' which can be downloaded here.

You can either copy the pages into your own theme if you have one or use the 'simple basis' theme as a starting point.

Create set of pages

For the plugin to work there needs to be set of blank pages created in wp-admin which correspond to the .php pages and .js files detailed previously. Title for the pages are listed below.

Add shortlist widget

Users can add properties to a 'shortlist' which appears in the 'results' view. This can be added as a widget in the wp-admin area. Your theme will need a widget area to be able to add the shortlist to it.

The cpd-simplebasis theme comes with a search results page which already includes the widget area.

If you are using your own theme you will need to add the corresponding widget area to your themes functions.php file.

Configure email templates

For agents marketing other properties than their own current instructions eg the full database search, the users will need to register so a set of email templates will be needed.

Users need to register their contact details to be able to get the full property details. After clicking on 'download shortlist' user will go to the 'register user' page and enter their contact details. The user will be sent an verification email to their registered address which when replied to will send the user to the 'verify-user' wordpress page.

The user will also be sent a copy of the properties details which were added to the shortlist.

The agent will be sent an email detailing the user activity and properties which where added to the 'shortlist' (We also seem to use the term 'register interest'

Currently the email templates are managed by CPD so you will need to contact us when you are ready and we will send you a set which can be customised with the company logo etc.

Add properties to the CPD database

For the search to display results an agent will first need to have properties in our 'commercial property database'.

Properties can be added through the members area. See full instructions here. Members area is FREE to use for 'commercial property agents'. This allows you to add, update, search and archive properties being marketed by your agency (current instructions) . You will also be able to register any current requirements you may have, which will be made available to subscribing agents that may be able to fulfill them .

Customise your search

Choose what type of properties or what area you want the search to apply. Agents can display results from all properties or just a selected area.

Developers can also see our API documentation to see ways in which agents sites can interface with our Commercial Property Database.

FAQ