If you have any question left, please drop a note with the discussion link of this page.
Wordpress Plugin
From Wiki.zanox.com
The project comprises the development of a WordPress plugin, which extends the WordPress search functionality. The plugin serves the purpose of displaying zanox ad media in addition to the regular blog search results based on the individual search query. The therefore developed plugin consists of two major functional elements.
- The extension of the WordPress Search functionality
- The extension of the administration panel to configure the plugin (screenshot)
Download
Go to http://wordpress.org/extend/plugins/zanox-search-extension/ to download the zanox Word Press Plugin.
Installation
The Plugin can be installed in two different ways.
Manual Installation
- In a first step for the manual installation the zip-archive needs to be downloaded.
- The content of the zip-Archive has to be extracted in to the following directory:
/wp-content/plugins - By now the plugin should appear in the configuration menu of the WordPress administration panel under Plugins → Installed
- The plugin has to be activated here in order to set it on live status.
Installation out of WordPress Plugin Directory
- You can find the point Plugins → Add New in the configuration menu of the administration panel. By selecting this option you can browse the public plugin directory on WordPress.org. Here you can select and install the corresponding plugins.
- The zanox Search Plugin is located in a public directory. One click on the plugin opens an information window which contains all relevant information on the plugin. Moreover the plugin can be installed directly by following the displayed instructions (Please make sure you have your FTP access data available when installing the plugin).
After installing the plugin the plugin configuration menu has to be selected in order to enter the zanox Connect ID for the zanox Web Services. The ad media will be displayed after the zanox Connect ID has been configured.
Configuration
After the successful installation of the plugin you can find the configuration menu within the administration panel under menu point Settings → zanox Search.
Web Service API Configuration
ConnectID
ConnectID, which is needed in order to use the zanox Web Services API. You have to order the zanox WordPress Plugin in the zanox Application Store in order to recieve a valid connectID.
Search Parameter
Sales region
This option displays a list of all sales regions available at zanox. The standard setting is on „all sales regions“. You can manually select one sales region at a time. In case there is no advertiser found within the sales region selected there will be no ad media displayed.
Minimum price limit
The minimum price is to be set as a full number in order to work correctly.
Maximum price limit
The maximum price is to be set as a full number in order to work correctly. The maximum price limit has to be above the minimum price limit. In case there is no product found within the defined price limits there will be no ad media displayed.
Advertiser
This option displays a list of all advertisers within the zanox advertising network. The standard setting is on „all advertisers“. You can manually select one advertiser at a time. In case there is no query-matching found within the product range of the selected advertiser there will be no ad media displayed.
Product category
This option displays a list of all product categories within the zanox advertising network. The standard setting is on „all categories“. You can manually select one category at a time. In case there is no query-matching found within the product range of the selected category there will be no ad media displayed.
Design of the search page
Number of products
The number of products displayed can be selected from 1 to 10 items.
Product images
Display of product images can be disabled by selecting no in the corresponding setting section.
Position
You can select two different positions for the zanox search results: above or below the WordPress standard search results.
Minimum System Requirements
- WordPress Version ≥ 2.7.1
- PHP 4/5 (Memory Size of of 18MB)
Installation layout
Installation directory
<WordPress-Main-Directory>/wp-content/plugins/zanox_search/
Plugin Files
<Plugin-Directory>zanox_search.php
This is the main file of the plugin. This file coordinates the installation and de-installation of the plugin as well as the request of the corresponding classes for the frontend and administration panel.
<Plugin-Directory>zanox_search_frontend.php
This file contains all necessary funcionalities in order to integrate the plugin into the WordPress search. Functionalities in this file retrieve the information from zanox Web Services on the basis of the query and search parameter. Moreover this file makes sure that the information retrieved is being displayed properly within the search results.
<Plugin-Directory>zanox_search_admin.php
This file contains all vital functionalities in order to adapt the configuration menu within the WordPress administration panel.
<Plugin-Directory>zanox_definition.inc.php
This file contains all static parameters of the configuration menu within the WordPress administration panel.
<Plugin-Directory>lib/z_ws_client/
This directory contains all zanox Web Services PHP Client Library files, which are vital for the information retrieval from zanox Web Services.
<Plugin-Directory>templates/admin.inc.php
HTML Template for the configuration menu within the WordPress administration panel.
<Plugin-Directory>templates/admin.css
CSS Stylesheet for the configuration menu within the WordPress administration panel.