无头(headless)模式的 WordPress 与 Astro
WordPress 是一个内容管理系统,虽然它包含了自己的前端,但也可以作为无头(headless)CMS 用于为你的 Astro 项目提供内容。
与 Astro 集成
段落标题 与 Astro 集成WordPress 自带了内置的 WordPress REST API,用于将你的 WordPress 数据连接到 Astro。你还可以选择在你的站点上安装 WPGraphQL 或 Gato GraphQL 来使用 GraphQL。
前期准备
段落标题 前期准备在开始前,你需要具备以下条件:
- 一个 Astro 项目 - 如果你还没有 Astro 项目,我们的安装指南可以帮助你快速上手;
- 一个 WordPress 站点 - 你的站点的 REST API 是
[YOUR_SITE]/wp-json/wp/v2/
,并在任何 WordPress 站点上都是默认提供的。你也可以在本地环境上安装 WordPress。
设置凭据
段落标题 设置凭据你的 WordPress REST API 默认情况下可以被外部请求以无需认证的方式获取数据。这不让用户修改你的数据或站点设置,而是让你在 Astro 项目中使用数据而无需任何凭据。
如果需要的话,你可以选择要求身份验证。
获取数据
段落标题 获取数据通过你的站点唯一的 REST API URL 和内容的路由来获取你的 WordPress 数据(对于博客,通常是 posts
),然后你可以使用 Astro 的 set:html={}
指令来渲染数据属性。
例如,要显示一个帖子标题和内容的列表:
WordPress REST API 包含了 全局参数,如 _fields
和 embed
。
所以可通过此 API 获取大量的数据,你也可能希望仅获取特定字段。你可以通过在 API URL 中添加 _fields
参数来限制响应,例如:[你的站点]/wp/v2/posts?_fields=author, id, excerpt, title, link
。
API 还可以返回与文章相关的内容,例如父级文章的链接或评论。你可以在 API URL 中添加 _embed
参数(例如 [你的站点]/wp/v2/posts?_embed
),提示服务器在响应中包含这些嵌入资源。
使用 WordPress 和 Astro 构建博客
段落标题 使用 WordPress 和 Astro 构建博客该示例从 https://norian.studio/dinosaurs/ 的公共 WordPress API 中获取数据。该 WordPress 站点将有关个别恐龙的信息存储在 dinos
路径下,就像博客将个别博文存储在 posts
路径下一样。
该示例展示如何在 Astro 中复制此站点结构:一个索引页面,列出恐龙并链接至动态生成的个别恐龙页面。
要在 WordPress API 中使用自定义文章类型(CPT)(不只是 post
和 page
),你需要在 WordPress 仪表盘中进行配置,或在 WordPress 中为自定义内容类型添加 REST API 支持。
该示例从已设置和公开至 REST API 的 WordPress 站点获取数据。
显示 WordPress 文章列表
段落标题 显示 WordPress 文章列表页面 src/pages/index.astro
列出每个恐龙的描述,并提供链接至其独立页面。
文件夹src/
文件夹pages/
- index.astro
文件夹dinos/
- [slug].astro
- astro.config.mjs
- package.json
通过 API 获取的对象包含以下属性:
title.rendered
- 包含文章标题的 HTML 渲染结果;content.rendered
- 包含文章内容的 HTML 渲染结果;slug
- 包含文章的 slug(用于生成动态生成的个别恐龙页面的链接)。
使用 WordPress API 生成页面
段落标题 使用 WordPress API 生成页面页面 src/pages/dinos/[slug].astro
为每个恐龙 动态生成了一个页面。
返回嵌入资源
段落标题 返回嵌入资源_embed
查询参数会告诉服务器返回相关的(嵌入的)资源。
返回 _embedded['wp:featuredmedia']['0'].media_details.sizes.medium.source_url
属性,并用于在每个恐龙页面上显示特色图像。(可将 medium
替换为你所需的图像尺寸。)
发布你的网站
段落标题 发布你的网站要部署你的网站,请访问我们的部署指南,并按照你偏好的托管提供商的步骤说明进行操作。
社区资源
段落标题 社区资源- Chris Bongers 的文章 使用 WordPress 作为无头 CMS 构建 Astro 网站。
- Ben Holmes 的直播 使用 Astro 和 WordPress 进行构建。
- Jeff Everhart 的文章 使用 Astro 构建无头 WordPress 网站。
- Darko Bozhinovski 的文章 Astro 和 WordPress 作为 API。
生产环境网站
段落标题 生产环境网站以下网站在生产环境中使用 Astro + WordPress:
- Rafid Muhymin Wafi 的 Soft Hard System — GitHub 上的源代码。
- Anindo Neel Dutta 的 Dinos! — GitHub 上的源代码。