Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/benjaminmedia/wp-cxense
A generic WordPress plugin for integrating with cXense
https://github.com/benjaminmedia/wp-cxense
cxense wordpress wordpress-plugin wp-cxense
Last synced: about 1 month ago
JSON representation
A generic WordPress plugin for integrating with cXense
- Host: GitHub
- URL: https://github.com/benjaminmedia/wp-cxense
- Owner: BenjaminMedia
- License: mit
- Created: 2016-09-23T07:48:07.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-02-12T09:52:12.000Z (11 months ago)
- Last Synced: 2024-09-16T17:15:40.930Z (4 months ago)
- Topics: cxense, wordpress, wordpress-plugin, wp-cxense
- Language: PHP
- Homepage:
- Size: 458 KB
- Stars: 2
- Watchers: 14
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Bonnier Publications - WordPress cXense plugin
This plugin enables your WordPress site to integrate with cXense.
It adds the meta tags and scripts needed by cXense in order to scan your site.
It also calls cXense whenever you make changes to your content.
Finally it adds the possibility to save a cXense recommendation widget per content type and provides hooks to call them in your view/theme.
### Requirements
- WordPress 4.3 or higher
- Language support (Optional) Polylang plugin must installed and activated version 1.8.4 or higher
- PHP 7.1 or higher
### Installation/Configuration
Install through composer:
``` bash
composer require benjaminmedia/wp-cxense
```
Download lastest release from: https://github.com/BenjaminMedia/wp-cxense/releases
And unzip and place in your /wp-content/plugins directory.
#### Settings
Once you have installed and activated the plugin then make sure that you have
a set of api credentials for the cXense API.
Once you have your credentials you may go to the settings page labeled cXense.
Here you must enter your ```cXense Site ID```, ```cXense API user```,
```cXense API key``` and finally your ```cXense Organisation prefix```.
##### Remember the plugin will not work until you check the ```Enable``` switch in the settings page
---
### Widgets
The plugin will generate a ```CX Widget ID``` settings field for each post type
you have available on your WordPress Installation. Here you must enter the
cXense recommendation widget ID that you would like represented on your
content type.
For debug purpose you can enable or disable the query cache. It is recommended to be enabled in production.
SortBy Widget ID will be only used for widgets sortby options in wp-base.
#### Rendering widgets
In order to render the widgets available for your post you should make sure
that you have filled out the ```CX widget ID``` field in the plugin settings
page.
When rendering the widgets the plugin provides you with two options:
1. Let cXense render the HTML of the widgets
2. Get the data and for the widget and build the HMTL yourself
Once you have picked the method you want to use you should go to the theme file
that represents the single view of your post_type from this file you may call the
following methods to get the widget data:
###### Let cXense render the HTML of the widgets
``` php
WpCxense::instance()->render_widget();
```
The sample output of this function could look like:
``` html
document.write(data.response.template + '\n');
...
```
---
###### Get the data and for the widget and build the HMTL yourself
``` php
WpCxense::instance()->get_widget_data();
```
The sample output of this function could look like:
``` php
array (size=12)
0 =>
object(stdClass)[2636]
public 'recs-articleid' => string '795' (length=3)
public 'bod-pagetype' => string 'recipe' (length=6)
public 'dominantthumbnail' => string 'http://content-thumbnail.cxpublic.com/content/dominantthumbnail/f95381682e3604de99d30788b24fb3a1538616ee.jpg?57e79849' (length=117)
public 'dominantthumbnaildimensions' => string '300x236' (length=7)
public 'title' => string 'Hindbærsmoothie med æble og lakrids' (length=37)
public 'click_url' => string 'http://api.cxense.com/public/widget/click/HV4bL7qxuVIVUmrMEsh4zQ6S2A5_BkkxEuByIzyDKMZAYCrJlJOTpy7QFvYxf7dkW0ljBE_55ig9vYxG3FNaXmKGsr03HH5w1wa7-E6mbJI-gdqHJNx6pgIjvKyM8TUGnhfwe0NsyjAkgzirNM66WfPhG9_Z9lsiWIJauO3C82KWYdRhA99EBXg6Ynsh9xwIq62wNJAaj_OPTVFhUuGiLxW7uVQ4DNT0BjRcn8ne0Uq6y8Ew0DYUDCfCFp6DwOy_D9MK7j5wpKSfRykLOGNNo35udNcfALBcZJfoMZ7Uqgs19IZeGrAv11RDIz1cNBmWq3yEn-QKqeKFgK7cqwjKeCr91PERbwGbDu4kN9xkv1NPjTK1M_attpQjlCLy3E9_JstO-aCxP6XtmtnIExUnl1Qq7iVPXAbP3fxlT3wmIOetk4IvoGKsXhdFkRIMCD1owQwY27bVvzwuPCgTXJ-7UO'... (length=599)
public 'url' => string 'http://maaltid.nu/opskrifter/hindbaersmoothie-med-aeble-og-lakrids' (length=66)
1 =>
object(stdClass)[2672]
public 'recs-articleid' => string '1369' (length=4)
public 'bod-pagetype' => string 'recipe' (length=6)
public 'dominantthumbnail' => string 'http://content-thumbnail.cxpublic.com/content/dominantthumbnail/6b0ddce458039f3905b5b3515356002536ab614c.jpg?57ea261a' (length=117)
public 'dominantthumbnaildimensions' => string '300x236' (length=7)
public 'title' => string 'Italiensk til middag: Risotto med 2 slags græskar og salvie' (length=60)
public 'click_url' => string 'http://api.cxense.com/public/widget/click/mLsD8MoXunkEcOtky6wQJXpRjzYcvvrFoXsONQdOI5FDqsmnlun6sVcaK-PIsvyT9KoXSvOKxiS4wzBrjGb0PaCtk_1bFn88sHSzq7LJF4CL7-Q4-50nJl3JC3oyrnAM1W_Cub7qXcAHSFmBjVkBjAGRaiA_F-Du9Y1q2by9YikilWco43hRZeUHVyQ2RLOZ7as8C1SeEXdKHeDi8HT5SGqMox-hAdBhwHNLtXLdJ_t1u9G90QOmQw-xitTc4PUknHSdtPyiDgYrBNNxHhOehs0_wHKGxka4k-g6VOAo7ovFGF2aRB-32QAqSPu_ohd-nNO_J0tEMll1uofTI9XCePnkI2O1W0Cq6MkEcyWVZQ-72hWiTrfn2z8x-BRd9ZE8cFvdWV8OU-Ojf02KEKesGfVgUltFY-HLImdE2NCkGV-jk7RoHYXesghIvfTufvKnMORmayI5lkLDZQ5Dp7u9wh'... (length=613)
public 'url' => string 'http://maaltid.nu/opskrifter/kom-i-godt-humor-med-graeskarrisotto-med-salvie' (length=76)
2 => ...
```
### Documents
#### Searching documents
If the key 'query' is missing from the search array then a [DocumentSearchMissingSearch](https://github.com/BenjaminMedia/wp-cxense/blob/search_documents/src/Bonnier/WP/Cxense/Exceptions/DocumentSearchMissingSearch.php) exception is thrown.
##### Search
``` php
WpCxense::instance()->search_documents([
'query' => 'search_term', // mandatory
'page' => 1, // optional, defaults to 1
'count' => 10, // optional, defaults to 10
'filter_operator => 'AND', // optional, defaults to OR
'filter' => [ // optional
'field' => [
'value',
],
],
'filter_exclude' => [ // optional
'field' => [
'value',
],
],
'facets' => [ // optional
0 => [
'type' => 'string',
'field' => 'field'
],
1 => [
'type' => 'string',
'field' => 'field'
]
],
'spellcheck' => true, // optional
'highlights' => [ // optional
0 => [
'field' => 'body',
'start' => '',
'stop' => '',
'length' => 50
]
]
]);
```
Searching documents will return an object of the following format:
``` php
object(stdClass)[543]
public 'facets' =>
array (size=2)
0 =>
object(stdClass)[538]
public 'buckets' =>
array (size=6)
...
1 =>
object(stdClass)[542]
public 'buckets' =>
array (size=3)
...
public 'totalCount' => int 79
public 'matches' =>
array (size=10)
0 =>
object(Bonnier\WP\Cxense\Parsers\Document)[521]
public 'id' => string '551790ba522b4b9427ca947e1b3353e137d78a85' (length=40)
public 'siteId' => string '1129402680464567580' (length=19)
public 'score' => float 2.0455377
public 'fields' =>
array (size=10)
...
public 'highlights' =>
array (size=1)
...
public 'spellcheck' =>
array (size=1)
0 =>
object(stdClass)[663]
public 'term' => string 'mor' (length=3)
public 'suggestions' =>
array (size=0)
...
```
The 'matches' key contains an array of objects that have the 'fields' value accessible directly through the magic method __get(). This means that you can call any field from the 'fields' with the direct pointer:
``` php
$objResults->matches[0]->author;
```
A complete document result looks like:
``` php
object(Bonnier\WP\Cxense\Parsers\Document)[710]
public 'id' => string '551790ba522b4b9427ca947e1b3353e137d78a85' (length=40)
public 'siteId' => string '1129402680464567580' (length=19)
public 'score' => float 0.40566906
public 'fields' =>
array (size=9)
0 =>
object(stdClass)[715]
public 'field' => string 'author' (length=6)
public 'value' => string 'i form' (length=6)
1 =>
object(stdClass)[718]
public 'field' => string 'bod-cat' (length=7)
public 'value' => string 'Sund graviditet' (length=15)
2 =>
object(stdClass)[719]
public 'field' => string 'bod-cat-top' (length=11)
public 'value' => string 'Sundhed' (length=7)
3 =>
object(stdClass)[720]
public 'field' => string 'bod-cat-url' (length=11)
public 'value' => string 'http://iform.dk/sundhed/sund-graviditet' (length=39)
4 =>
object(stdClass)[721]
public 'field' => string 'bod-pagetype' (length=12)
public 'value' => string 'article' (length=7)
5 =>
object(stdClass)[722]
public 'field' => string 'description' (length=11)
public 'value' => string 'Går du med babytanker, har du en fordel, hvis du bor tæt på din mor.' (length=71)
6 =>
object(stdClass)[723]
public 'field' => string 'recs-publishtime' (length=16)
public 'value' => string '2015-04-19T22:00:00.000Z' (length=24)
7 =>
object(stdClass)[724]
public 'field' => string 'title' (length=5)
public 'value' => string 'Din mor øger dine baby-chancer' (length=31)
8 =>
object(stdClass)[725]
public 'field' => string 'url' (length=3)
public 'value' => string 'http://iform.dk/sundhed/sund-graviditet/din-mor-kan-hjaelpe-til-familieforoegelsen' (length=82)
```
#### Widget documents
If the key 'widget_id' is missing from the input array then a [WidgetMissingId](https://github.com/BenjaminMedia/wp-cxense/blob/search_documents/src/Bonnier/WP/Cxense/Exceptions/WidgetMissingId.php) exception is thrown.
Example how to fetch cxense data
``` php
WidgetDocumentQuery::make()
->addContext('url', get_permalink())
->setMatchingMode($this->getCxenseTaxonomy())
->addParameter('pageType', 'article gallery story')
->setCategories(array($this->getCategory()))
->setTags(array($this->getTag()))
->get();
```
#### Recently viewed by user 'TAX_RECENT'
This type of taxonomy requires user browser cookie. In order to fetch it from the browser console you can use
```
cX.getUserId()
```
