regionhalland/region-halland-plugin-rest-widgets

v1.2.0 2023-11-24 13:59 UTC

Requires (Dev)

• squizlabs/php_codesniffer: 3.*

GPL-3.0

• Region Halland

README

Användningsområde

Detta plugin används för att hämta ut widget areas (även kallade sidebars) och dess data via WPs REST API.

Följande endpoints läggs till:

Endpoint	Användning	Svarsexempel
/wp-json/rh/v1/widgets/	Returnerar en array med alla widget areas och dess färdigrenderade HTML som enskilda objekt	Exempel på svar
/wp-json/rh/v1/widgets/<sidebar>	Returnerar en enskild widget area som objekt baserat på dess id i temats 'register_sidebar'. Exempelvis wp-json/rh/v1/widgets/footer-column-1	Exempel på svar
/wp-json/rh/v1/widgets/prefix/<prefix>	Returnerar en array med alla widget areas (sidebars) som matchar ett prefix, som enskilda objekt. Om man exempelvis har 3 footer-kolumner vars id alla börjar med 'footer-column-' så kan man gå mot /wp-json/rh/v1/widgets/prefix/footer-column- för att hämta alla footer-kolumner	Exempel på svar

Exempel på API-svar

Alla widget areas (/wp-json/rh/v1/widgets/)

[
	{
		"name": "Footer column 1",
		"id": "footer-column-1",
		"html": "<li id=\"text-2\" class=\"widget widget_text\"><h2 class=\"widgettitle\">Text i kolumn 1</h2>\n\t\t\t<div class=\"textwidget\"><p>Text i kolumn 1</p>\n</div>\n\t\t</li>\n"
	},
	{
		"name": "Footer column 2",
		"id": "footer-column-2",
		"html": ""
	},
	{
		"name": "Footer column 3",
		"id": "footer-column-3",
		"html": ""
	}
]

En enskild widget area (/wp-json/rh/v1/widgets/footer-column-1)

{
	"name": "Footer column 1",
	"id": "footer-column-1",
	"html": "<li id=\"text-2\" class=\"widget widget_text\"><h2 class=\"widgettitle\">Text i kolumn 1</h2>\n\t\t\t<div class=\"textwidget\"><p>Text i kolumn 1</p>\n</div>\n\t\t</li>\n"
}

Alla widget areas enligt prefix (/wp-json/rh/v1/widgets/prefix/footer-column-)

[
	{
		"name": "Footer column 1",
		"id": "footer-column-1",
		"html": "<li id=\"text-2\" class=\"widget widget_text\"><h2 class=\"widgettitle\">Text i kolumn 1</h2>\n\t\t\t<div class=\"textwidget\"><p>Text i kolumn 1</p>\n</div>\n\t\t</li>\n"
	},
	{
		"name": "Footer column 2",
		"id": "footer-column-2",
		"html": ""
	},
	{
		"name": "Footer column 3",
		"id": "footer-column-3",
		"html": ""
	}
]

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/RhRestWidgets

Läs in pluginen via composer

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

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

Versionhistorik

Se CHANGELOG.md