regionhalland/region-halland-plugin-rest-widgets

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

This package is not auto-updated.

Last update: 2024-09-25 04:32:02 UTC


README

应用范围

此插件用于通过WPs REST API获取小工具区域(也称为侧边栏)及其数据。

以下端点被添加

端点用途响应示例
/wp-json/rh/v1/widgets/返回一个包含所有小工具区域及其渲染的HTML的数组,每个小工具区域作为一个对象示例响应
/wp-json/rh/v1/widgets/<sidebar>返回一个基于其id在主题的'register_sidebar'中的对象的单个小工具区域。例如 wp-json/rh/v1/widgets/footer-column-1示例响应
/wp-json/rh/v1/widgets/prefix/<prefix>返回一个包含所有匹配前缀的小工具区域(侧边栏)的数组的对象。例如,如果您有3个id以'footer-column-'开始的footer列,则可以访问/wp-json/rh/v1/widgets/prefix/footer-column-以获取所有footer列示例响应

API响应示例

所有小工具区域(/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": ""
	}
]

一个单独的小工具区域(/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"
}

根据前缀的所有小工具区域(/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": ""
	}
]

许可证模型

此插件使用许可证模型GPL-3.0。您可以通过附带的"LICENSE"文件了解更多关于此许可证模型的信息。

安装和激活

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

通过Git下载插件

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

通过composer导入插件

注意!确保您下载的是最新版本。

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

版本历史

查看CHANGELOG.md