regionhalland/region-halland-plugin-filters

Plugin för att öppna endpoints med WP data som kan användas för filtrering

v2.1.0 2020-11-23 10:27 UTC

Requires (Dev)

• squizlabs/php_codesniffer: 3.*

GPL-3.0

• Region Halland

README

Användningsområde

Detta plugin har funktionalitet för att hämta ut kategorier och posttyper samt API endpoints för att hämta ut denna data

Licensmodell

Denna plugin använder licensmodell GPL-3.0. Du kan läsa mer om denna licensmodell via den medföljande filen "LICENSE"

Installation och aktivering

A) Hämta pluginen via Git eller läs in det med Composer
B) Installera Region Hallands plugin i Wordpress plugin folder
C) Aktivera pluginet inifrån Wordpress admin

Hämta hem pluginet via Git

git clone https://regionhalland.visualstudio.com/public.RhWpPlugIns/_git/RhFilters

Läs in pluginen via composer

OBS! Justera så att du hämtar aktuell version.

"require": {
  "regionhalland/region-halland-plugin-filters": "1.0.0"
},

Exempel på array

Kategorier

För att hämta ut en lista av kategorier i WordPress så används 'get_region_halland_filters_categories'.

PHP array

array(9) {
  [0]=>
  object(WP_Term)#4743 (10) {
    ["term_id"]=>
    int(3)
    ["name"]=>
    string(21) "Demokrati och politik"
    ["slug"]=>
    string(21) "demokrati-och-politik"
    ["term_group"]=>
    int(0)
    ["term_taxonomy_id"]=>
    int(3)
    ["taxonomy"]=>
    string(8) "category"
    ["description"]=>
    string(38) "Nyheter i ämnet Demokrati och politik"
    ["parent"]=>
    int(0)
    ["count"]=>
    int(21)
    ["filter"]=>
    string(3) "raw"
  }
  [1]=>
  object(WP_Term)#4744 (10) {
    ["term_id"]=>
    int(10)
    ["name"]=>
    string(13) "Folktandvård"
    ["slug"]=>
    string(12) "folktandvard"
    ["term_group"]=>
    int(0)
    ["term_taxonomy_id"]=>
    int(10)
    ["taxonomy"]=>
    string(8) "category"
    ["description"]=>
    string(0) ""
    ["parent"]=>
    int(0)
    ["count"]=>
    int(11)
    ["filter"]=>
    string(3) "raw"
  }
}

JSON array

Kallar man funktionen med parametern "json" får man det istället json encodat:

[
	{
		"term_id": 3,
		"name": "Demokrati och politik",
		"slug": "demokrati-och-politik",
		"term_group": 0,
		"term_taxonomy_id": 3,
		"taxonomy": "category",
		"description": "Nyheter i ämnet Demokrati och politik",
		"parent": 0,
		"count": 21,
		"filter": "raw"
	},
	{
		"term_id": 10,
		"name": "Folktandvård",
		"slug": "folktandvard",
		"term_group": 0,
		"term_taxonomy_id": 10,
		"taxonomy": "category",
		"description": "",
		"parent": 0,
		"count": 11,
		"filter": "raw"
	}
]

Posttyper

För att hämta ut en lista av posttyper i WordPress så används 'get_region_halland_filters_post_types'.

PHP array

array(6) {
  [0]=>
  array(2) {
    ["slug"]=>
    string(4) "news"
    ["name"]=>
    string(7) "Nyheter"
  }
  [1]=>
  array(2) {
    ["slug"]=>
    string(17) "kulturarrangemang"
    ["name"]=>
    string(17) "Kulturarrangemang"
  }
  [2]=>
  array(2) {
    ["slug"]=>
    string(13) "kulturprogram"
    ["name"]=>
    string(13) "Kulturprogram"
  }
  [3]=>
  array(2) {
    ["slug"]=>
    string(6) "blurbs"
    ["name"]=>
    string(6) "Puffar"
  }
  [4]=>
  array(2) {
    ["slug"]=>
    string(4) "post"
    ["name"]=>
    string(7) "Inlägg"
  }
  [5]=>
  array(2) {
    ["slug"]=>
    string(4) "page"
    ["name"]=>
    string(5) "Sidor"
  }
}

JSON array

Kallar man funktionen med parametern "json" får man det istället json encodat:

[
	{
		"slug": "news",
		"name": "Nyheter"
	},
	{
		"slug": "kulturarrangemang",
		"name": "Kulturarrangemang"
	},
	{
		"slug": "kulturprogram",
		"name": "Kulturprogram"
	},
	{
		"slug": "blurbs",
		"name": "Puffar"
	},
	{
		"slug": "post",
		"name": "Inlägg"
	},
	{
		"slug": "page",
		"name": "Sidor"
	}
]

Versionhistorik

2.0.0

• BREAKING CHANGE: Posttypers fält 'title' har ändrats till 'name' för att vara konsekvent med strukturen i kategorierna

1.0.0

• Första version inkl publicering på Packagist