WordPress 无头 CMS 的 Next.js 起始模板
这是一个起始模板,用于构建使用 WordPress REST API 从 WordPress 站点获取数据的 Next.js 应用程序。该模板包含了从 WordPress 站点获取文章、分类、标签、作者和特色媒体的函数,并在 Next.js 应用程序中渲染它们。
next-wp
使用 Next.js 14、React、Typescript、Tailwind、shadcn/ui 和 brijr/craft 构建。它与 brijr/components 搭配使用,可以实现快速开发体验。由 9d8 构建。
目录
概述
lib/wordpress.ts
-> 通过 REST API 获取 WordPress CMS 的函数lib/wordpress.d.ts
-> WP REST API 的类型声明components/posts/post-card.tsx
-> 文章的组件和样式app/posts/filter.tsx
-> 处理文章过滤的组件
需要在 .env.local
文件中设置两个 env
变量:
WORDPRESS_URL="https://wordpress.com"
WORDPRESS_HOSTNAME="wordpress.com"
你可以在 .env.example
文件(以及 Vercel)中找到 .env.local
文件的示例:
WordPress 函数
lib/wordpress.ts
文件包含了几个使用 WordPress REST API 从 WordPress 站点获取数据的函数。以下是每个函数的简要概述:
-
getAllPosts(filterParams?: { author?: string; tag?: string; category?: string; })
: 从 WordPress 站点获取所有文章。可以选择传递过滤参数,按作者、标签或分类过滤文章。 -
getPostById(id: number)
: 通过 ID 获取单篇文章。 -
getPostBySlug(slug: string)
: 通过别名获取单篇文章。 -
getAllCategories()
: 从 WordPress 站点获取所有分类。 -
getCategoryById(id: number)
: 通过 ID 获取单个分类。 -
getCategoryBySlug(slug: string)
: 通过别名获取单个分类。 -
getPostsByCategory(categoryId: number)
: 通过分类 ID 获取属于特定分类的所有文章。 -
getPostsByTag(tagId: number)
: 通过标签 ID 获取带有特定标签的所有文章。 -
getTagsByPost(postId: number)
: 通过文章 ID 获取与特定文章相关的所有标签。 -
getAllTags()
: 从 WordPress 站点获取所有标签。 -
getTagById(id: number)
: 通过 ID 获取单个标签。 -
getTagBySlug(slug: string)
: 通过别名获取单个标签。 -
getAllPages()
: 从 WordPress 站点获取所有页面。 -
getPageById(id: number)
: 通过 ID 获取单个页面。 -
getPageBySlug(slug: string)
: 通过别名获取单个页面。 -
getAllAuthors()
: 从 WordPress 站点获取所有作者。 -
getAuthorById(id: number)
: 通过 ID 获取单个作者。 -
getAuthorBySlug(slug: string)
: 通过别名获取单个作者。 -
getPostsByAuthor(authorId: number)
: 通过作者 ID 获取特定作者写的所有文章。 -
getPostsByAuthorSlug(authorSlug: string)
: 通过作者别名获取特定作者写的所有文章。 -
getPostsByCategorySlug(categorySlug: string)
: 通过分类别名获取属于特定分类的所有文章。 -
getPostsByTagSlug(tagSlug: string)
: 通过标签别名获取带有特定标签的所有文章。 -
getFeaturedMediaById(id: number)
: 通过 ID 获取特色媒体(如特色图片)。
这些函数提供了一种方便的方式与 WordPress REST API 交互,并从你的 WordPress 站点检索各种类型的数据。它们可以在你的 Next.js 应用程序中用于获取和显示 WordPress 内容。
WordPress 类型
lib/wordpress.d.ts
文件包含了各种 WordPress 实体和相关数据结构的 TypeScript 类型定义。以下是主要类型的概述:
-
Post
: 表示一个 WordPress 文章,包含诸如id
、title
、content
、excerpt
、author
、categories
、tags
等属性。 -
Category
:表示 WordPress 分类,具有id
、name
、slug
、description
、parent
和count
等属性。 -
Tag
:表示 WordPress 标签,具有与Category
类似的属性,包括id
、name
、slug
、description
和count
。 -
Page
:表示 WordPress 页面,具有id
、title
、content
、excerpt
、author
、parent
和template
等属性。 -
Author
:表示 WordPress 作者,具有id
、name
、slug
、description
、avatar_urls
和meta
等属性。 -
BlockType
:表示 WordPress 区块类型,具有name
、title
、description
、icon
、category
、attributes
等属性。 -
EditorBlock
:表示 WordPress 编辑器中的区块,具有id
、name
、attributes
、innerBlocks
和innerHTML
等属性。 -
TemplatePart
:表示 WordPress 中的模板部分,具有id
、slug
、theme
、type
、content
、title
和status
等属性。 -
SearchResult
:表示 WordPress 的搜索结果,具有id
、title
、url
、type
和subtype
等属性。 -
FeaturedMedia
:表示 WordPress 中的特色媒体(如特色图片),具有id
、title
、caption
、alt_text
、media_details
和source_url
等属性。 -
FilterBarProps
:表示过滤栏组件的属性,包含authors
、tags
、categories
以及每个选项的选定值。
这些类型定义在 Next.js 应用中处理 WordPress 数据时提供了类型安全和自动完成功能。它们确保在与 WordPress REST API 交互时访问正确的属性并传递预期的数据类型。
文章卡片组件
components/posts/post-card.tsx
文件包含 PostCard
组件,负责在应用中渲染单个文章卡片。以下是该组件的概述:
属性
post
:表示要渲染的 WordPress 文章的Post
对象。
功能
-
组件使用
lib/wordpress.ts
中的getFeaturedMediaById
、getAuthorById
和getCategoryById
函数获取与文章关联的特色媒体、作者和分类。 -
使用
toLocaleDateString
方法和指定选项格式化文章日期。 -
组件使用文章的 slug 渲染指向单独文章页面的链接。
-
在链接内,显示文章的特色图片、标题、摘要、分类和日期。
-
使用
dangerouslySetInnerHTML
属性渲染文章标题和摘要,以处理 HTML 内容。 -
组件应用各种 CSS 类来设置文章卡片样式,包括悬停效果和过渡。
使用方法
要使用 PostCard
组件,将其导入到所需的页面或组件中,并将 Post
对象作为 post
属性传递。
过滤组件
components/posts/filter.tsx
文件包含 FilterPosts
组件,提供基于标签、分类和作者的文章过滤界面。以下是该组件的概述:
属性
authors
:表示可供过滤的作者的Author
对象数组。tags
:表示可供过滤的标签的Tag
对象数组。categories
:表示可供过滤的分类的Category
对象数组。selectedAuthor
:可选的字符串,表示当前选定的作者 ID。selectedTag
:可选的字符串,表示当前选定的标签 ID。selectedCategory
:可选的字符串,表示当前选定的分类 ID。
功能
-
组件使用 Next.js 的
useRouter
钩子处理基于选定过滤器的导航和 URL 更新。 -
它渲染三个
Select
组件,用于按标签、分类和作者过滤文章。每个Select
组件显示可用选项,允许用户选择特定值或选择"全部"以重置过滤器。 -
当过滤器值发生变化时,会调用
handleFilterChange
函数,传入过滤器类型和选定值。它相应地更新 URL 查询参数并导航到更新后的 URL。 -
组件还包括一个"重置过滤器"按钮,点击时调用
handleResetFilters
函数,导航回不带任何过滤器的/posts
页面。 -
选定的过滤器值作为属性传递给组件,用于设置
Select
组件的初始值。
由 Bridger Tower 和 Cameron Youngblood 在 9d8 构建