@ getquick/ 内容
运行时间的公开 search({ search, page?, perPage?, language? }) 搜索
已交付的网页、文章、申报的藏品和语文首页
独自从出版商店。 它返回一个 found.content 页面为
items, (中文(简体) ), total, (中文(简体) ), page, (中文(简体) ), perPage, (中文(简体) ), totalPages,或 unavailable.failure。 。 。 .
见 搜索合同和收养指南。 。 。 .
WordPress HTML和WPGraphQL的配置内容运行时间. 这个
提供纯助手、配置的 WordPress 客户端、持久发送和
安装了 SQL 迁移,以及事件/更新的 HTTP 处理器。 它被释放作为一个
与 Composers 软件包对齐 getquick/gq-content,在同一版本和标签上.
import { renderWordPressBlocks, htmlLang } from "@getquick/content";
import { createContentRuntime } from "@getquick/content/server";
const content = createContentRuntime({
site: "my Site identity",
graphqlEndpoint: "https://cms.example.test/wp/graphql",
cmsOrigin: "https://cms.example.test",
wordpress: {
locale: "pt_PT_ao90",
languages: [{ locale: "en_US", slug: "en" }],
},
isServer: () => true, // Supply the framework's lazy server-context check.
bindings: () => ({}), // Supply fresh request bindings, including optional credentials.
});
const home = await content.wordpress.getHomeContent(content.defaultLanguage);
const entry = await content.wordpress.getEntryByUri("/about/");
const chrome = await content.wordpress.getSiteChrome("https://www.example.test", {
language: content.routeLanguage("/en/about/"),
});
站点提供所有配置:没有显示、框架环境或
Cloudflare发现被导入. 在实际可行的情况下构建每个请求。 A 类
长寿的例子将它称为对每一个送货业务和CMS请求的有约束力获取器. 留着
图QL读取身份与自动化身份分开. 部分证书
运输前的对失败。 带有证书, 只有配置的 HTTPS CMS
来源于 /graphql 或者说 /wp/graphql,不使用 URL 用户信息,则允许。 读取使用
手动重定向和八秒截止; 无法读取返回,
缺少已确认的缺失返回, 并成功读取已找到的返回 .
根项包含纯助行和公有结构类型. 服务器
进口 createContentRuntime, (中文(简体) ), ContentConfig, (中文(简体) ), ContentExtension, (中文(简体) ),
ExtensionNode, (中文(简体) ), CollectionConfig, (中文(简体) ), ContentBindings, (中文(简体) ), ContentRuntime 财务报告和审定财务报表 WordPressClient。运行时属性包含语言,
路由函数和WordPress方法; 证书/配置保存
关闭。 语言配置保留了源的正常化政策,
和路由返回该实例数组所持有的相同语言对象.
可重复使用的客户端方法保留其参数顺序:
getHomeContent(language?)getEntryByUri(uri)getDesignPresets()getPublishedEntries()getPublishedRoutes()getArchives()getSiteChrome(siteOrigin?, { location?, language? }?)(菜单,标志,图标, 页眉和页脚图案)
从寄存器根, 使用 vp install 财务报告和审定财务报表 vp run validate验证
通过Vite+ Pack建立汇编的无害环境管理/声明,检查格式/lint/类型,
运行包件边界套房,然后在一次性消费者中包装和安装
没有私人注册配置. vp run test 测试前重建;
vp test frontend/tests/wordpress-access.test.ts 在明确后有用
vp pack 在有重点的执行周期内。 构建输出是故意的
未入轨. npm tarball 允许列表仅包含已编译的输出, 五个原始 SQL 迁移, 即
单独同意数据库迁移和软件包元数据(npm还包含这个README).
公共分娩方法是 publishedHome(siteOrigin?, language?), (中文(简体) ),
publishedEntry(path, siteOrigin?), (中文(简体) ), pageChrome(siteOrigin?) 财务报告和审定财务报表
designPresets()供应a
PUBLICATION_DB 提供耐用出版物的结构约束。 存储读取
不需要事件或刷新秘密 保留最后已知的好内容
年龄限制。 寒冷的入门检查读过一次CMS, 保存缺失的相对
无法使用、犬科路线、语言隔离和有条件的晋升.
无法返回商店的生产( Chrome 返回为无效) 。 仅
development: true 启用没有商店的活读. 存储失败从不
启动后退 所有公众在绑定前都会读取守护服务器上下文
或运输.
designPresets() 返回已存储的设计预设,用于不是
出版物(只在明确开发时使用,否则无效)和
internalOrigins(siteOrigin?) 来源 menuItemHref 视之为本站.
blockPresetStyles(spacing, colors, scope?) 将预设的类扩展为 a
集装箱(.prose-wp 默认; presetRootStyle(spacing, colors) 声明
预设在 :root。 。 。 .
A 站点本身的内容
一个 WordPress 插件在其页面上添加字段并发布声明的网站
作为 extension。运行时间与每个首页、页面和帖子一起阅读
(与它的块),存储网站的价值与出版物并服务于它,
已键入,通过停机 :
const content = createContentRuntime<SiteBlocks>({
// …the configuration above…
extension: {
fields: { page: "wpBlocksJson pageBackgroundColor", post: "wpBlocksJson" },
// The Site's value for a node WordPress returned, or undefined for none.
read: ({ kind, fields }) => siteBlocks(fields.wpBlocksJson, fields.pageBackgroundColor),
// The stored value (JSON) read back, or undefined when it can't be served.
parse: (stored) => storedSiteBlocks.safeParse(stored).data,
},
});
const page = await content.publishedEntry("/about/");
if (page.kind === "found" && page.content.entry.extension) {
// Render page.content.entry.extension (SiteBlocks); the front page's is
// home.page.extension.
}
在网站宣布服务之前存储的行没有它;刷新存储它. 读取抛出失败为 WordPress 的答案不符合方案, 读取 没有它的块存储什么, 所以存储的页面保持服务。 见ADR0004.
页眉和页脚图案
铬也携带着 header 财务报告和审定财务报表 footer: 同步模式 GQ 设计
为设计路线选择页眉和页脚 designTemplate (默认)
"page"; 还 "front-page", (中文(简体) ), "home", (中文(简体) ), "archive", (中文(简体) ), "single-post" 或一个
站点定义路线). 每个都是 { title, blocks },或者当区域使用时无效
选择模板部分或未发布的内容: 保留网站自己的标题
或脚后。 它们被贮存,刷新并与铬调和,所以
游客通过CMS停用来保持最后已知的好景区. 选中的
模式 GQ 设计解析到任何块都无法读取铬并保存什么
被存储。 A 类 patterns 设置事件刷新了铬。 见
ADR 0006 (韩语)。 。 。 .
配置的路线在全球共享,包括主页和员额; 内容不会为每个访问者URL选择不同的设计路径. 使用一个 在 Design 运算表中注册的密钥: 未知密钥也返回为无效,以及 内容从不重复另一个密钥 .
所需GQ设计:0.4.1或更新 默认 page (单位:千美元)single 财务报告和审定财务报表
search gQ 设计 0.17至0.4.0 答案无效 page,所以请
网站保留自己的区域。 GQ 设计无 designPattern 总计(在
0.2.17)不会使染色体失效:读取时没有规律,既无规律,也无规律
警告名称 GQ 设计及其需要的版本 (WordPress: GQ Design has no designPattern field …) (中文(简体) ). 公众选择排除未公布
route/part source 和未发布,被保护或未同步的最终模式.
权威无效删除成功刷新上一个选择;
失败或畸形读取保留 .
普通菜单和出版物存储行仍为语言专用,但
designPattern 不使用语言。 每种语言都得到同样的不合格
模式选择及其序列数据。 翻译图案树被屏蔽
以 gq 设计 # 53。 。 。 .
制作一个图案 与网站的块化器。 带有已保存的 HTML 块
以他们的子嗣配他们; core/site-logo 有内置
渲染器; 没有 HTML (动态或站点块) 的任何其他块都需要一个
变形器。 集装箱接收基本的WordPress包装器和GQ设计
getquick-design/container 作为内容的布局( 宽度、 间隙、 垫)
容器有;未解决的活性叶片没有产生任何结果,并报告给
onUnrendered数字 :
import { designMenuItems, escapeHtml, type DesignBlockRenderer } from "@getquick/content";
const headerNavigation: DesignBlockRenderer = (block, { href }) =>
`<nav aria-label="Primary"><ul>${designMenuItems(block.attributes.menuItems, href)
.map((item) => `<li><a href="${escapeHtml(item.href)}">${escapeHtml(item.label)}</a></li>`)
.join("")}</ul></nav>`;
const header = content.renderDesignPattern(chrome?.header, {
siteOrigin: Astro.site?.origin,
home: language.home,
blocks: { "getquick/header-navigation": headerNavigation },
onUnrendered: (block) => console.warn(`No renderer for ${block.name}`),
});
成像器接收该块(name, (中文(简体) ), attributes, (中文(简体) ), content, (中文(简体) ), children(中文(简体) )
和背景: children (根据要求提交), render(blocks), (中文(简体) ),
ancestors, (中文(简体) ), home 财务报告和审定财务报表 href(url),作为路径服务 CMS 和 Site 链接
并用 #。其输出被插入为 HTML: excess
CMS 文本为 escapeHtml。保存的 HTML 被信任的已发布的 CMS 标记,
未由此助手进行消毒; 完整自定义间隔/ 排出样式需要一个站点
变形器。 与 consent 配置, 已保存的 HTML 模式有其
如尸体一样,将嵌入物重新写入同意占位符; 成像器建筑
嵌入属性用途 embedPlaceholder (单位:千美元)@getquick/content/consent(中文(简体) )
自己来 纯洁 renderDesignPattern 从根条目
带 internalOrigins 改为 siteOrigin。 。 。 .
收藏和档案
Site 将其自定义的邮站类型项目存储为收藏,并将其列表于 用于存档 Page 的列表 块 :
const content = createContentRuntime({
// …the configuration above…
collections: {
biblioteca: {
postType: "biblioteca", // WordPress's name
graphqlType: "Biblioteca", // its graphql_single_name
taxonomies: ["categoria_biblioteca"], // each show_in_graphql
},
},
});
const page = await content.list({
collection: "biblioteca",
terms: { categoria_biblioteca: ["legislacao"] }, // any slug; every taxonomy given slugs
search: "lei", // title and excerpt, ignoring case and accents
page: 1, // a number (or numeric string); anything else throws
perPage: 12,
});
// { kind: "found", items: [{ uri, title, date, modifiedAt, excerpt,
// featuredImage, terms, extension?, language? }], total, page, pages }
// or { kind: "unavailable", failure }
const filters = await content.terms("biblioteca", "categoria_biblioteca");
// { kind: "found", terms: [{ slug, name, count }] }
const archive = await content.archiveUri("biblioteca"); // "/biblioteca/" or null
项目为条目:事件、退出和对账保存
publishedEntry 为他们服务 entry.collection (单位:千美元)name, (中文(简体) ), terms) (中文(简体) ). 这个
扩展名 fields.collections[<name>] 选择项目本身的字段( e)read
获得 kind: "item" 财务报告和审定财务报表 collection) (中文(简体) ). 在WordPress, GetQUICK —— 档案
指定每个类型 a Page, 它将接收该类型存档地址; 保存
它再次读取每个归档地址。 类型或分类 WPGraphQL 不
显示, a graphqlType 不是类型, 或分类学没有联系
它的失败 档案读取,名字。 见ADR0005.
基础设施分别导入节点迁移条目:
import { migrationsDirectory } from "@getquick/content/migrations";
// Alchemy beta.79: Cloudflare.D1.Database("Publications", {
// migrations: migrationsDirectory,
// });
导出字符串解析到已安装软件包内的5个SQL文件.
将这一基础设施条目从浏览器和工人进口中排除。 根/ 服务器
图中包含无节点迁移模块. vp run alchemy 包/装有pnpm
并练习被钉住的Alchemy本地 D1/工人生命周期,包括更新
移民身份和出版物数据不变。 此证明使用本地
没有远程资源或证书。 见寄存器的第4期证据.
HTTP 方法为 handleEvent(request, { siteOrigin? }?) 财务报告和审定财务报表
handleRefresh(request, { siteOrigin? }?),两个返回标准 Response编号.
站点将其POST路线直接接入这些方法;其他方法返回
405号 Allow: POST. 对策的使用 Cache-Control: no-store。 。 。 .
事件需要 PUBLICATION_EVENT_SECRET 需要刷新
FRONTEND_REFRESH_TOKEN,每个字符至少32个,加 PUBLICATION_DB。 。 。 .
缺失或简短的证书会禁用其处理器而不禁用存储
公众阅读。 事件 HMAC 核查和现场/检查在任何内容管理系统之前
读取或存储更改。 刷新使用无记名授权; {} 刷新该
整个网站和 {"uris":["/about/"]} 目标 1–100 入门路径。 语言之家
需要全场刷新。 签名退出会隐藏所有存储的路径
该条目立即, 不读CMS。 刷新无法提升;
只有以后的出版物可以.
签名 reconcile 事件比较教义共享行和完整
通过正常出版规则修复差异,以及
旋转未修改条目的重读。 运行持有 D1 租赁, 保留有界限的 CMS
要求预算,并坚持成果和待清点,以继续.
答复保留源协议:200 reconciled, (中文(简体) ), behind 或者说 busy· ;
503个 failed,保留最后已知的好内容. 删除不完整的列表
没什么 每个被配置的语言都有单独的家/相色行;设计是
共享.
签名 check 事件返回 { status: "checked", site, reconciliation, store }。 。 。 .
store 报告共享行状态、条目状态计数、主动退出和
失败的事件, 加上其它语言行状态 languages无效
当无法使用时. reconciliation 报告上次运行、计数、失败和
最后一次匹配,或者在任何运行前无效。 这些是运行中的证据
准备就绪的蓝图大门;准备指挥、媒体检查和供应
仍为蓝图所有。 任何存储或调节帮助者都不是公共出口.
vp run pair 安装了WordPress/包装运输; vp run alchemy
保留本地安装的包装/工作迁移和协议证明.
vp run reconciliation 额外安装对并运行实际
WordPress/Polylang CLI和调度器HTTP进入已安装的工人消费者,
使用来自真实 CMS 状态的 GraphQL 解答。 它能证实趋同,
全工人部分运行、停用/恢复和完成待处理/失效记录
更新。 P6释放的全部证据仍然是第11期.
同意和法律联系
CONSENT-1/LEGAL-1号舰作为孤立条目: @getquick/content/consent
(中立核心), /consent/client (浏览器运行时间), /consent/server (单位:千美元)
/gq/consent 记录和读取终点和清洗), /consent/migrations
(单独的同意数据库), /consent/html (违约UI和法律
页脚为 HTML ), /consent/astro (兼容再出口)和 /consent/testing (接收套房). 他们进口不
内容运行时间,框架或WordPress客户端. 通过
consent: { services: ["youtube"], cmsSettings: true } 改为
createContentRuntime 改写第三方嵌入同意占位符
gq-config的法律合同和GA4的设置
语言的铬; runtime.consentConfiguration(chrome) 返回页面
同意配置。 见寄存器的 docs/consent.md 导出索引和
平台拥有 同意 HTML 引用
(单位:千美元)平台 PR # 273) (中文(简体) ).
设计格式和组成
站点导入 Cononic 演示文稿和主题 API @getquick/content。 。 。 .
软件包捆绑其被绑定的设计制造器和合同; 站点不安装
那些包裹本身。 应用 gqd-content 体能和铬区域发射
designThemeStyleSheet(theme) 接下来是 presentationStyleSheet(theme) 一次
每个答复,使用已交付 theme 从入/出/出/出。 解析默认
与 resolveDesignTheme 用于储存的旧出版物。 需要更改主题
重新生成两个样式表,包括其介质阈值.
字体和文本样式
GQ 设计 0.10.1 或 更新( 合同 2. 1.0; 本包捆绑 0. 10.4) 交付 Site 的自寄字体家族
(网站本身或媒体主机上的相片,每张相片都配有量度匹配的本地
倒计时) sans编号 :serif编号 :mono 时间档任务和
段落文本样式。 设计预设可选 fonts 财务报告和审定财务报表
textStyles:与其他预设一起阅读,与预设一起存储,被刷新
design 设置事件(全局样式保存、字体槽分配或
Font Library family 或 face saved 或被删除),并通过调和来比较.
一个CMS,其GQ设计在它们拒绝字段之前;预设读取
并保持主题的系统堆栈.
一次一次一次一次一次一次一次一次一次一次一次一次 designThemeStyleSheet(theme)数字 :
<style is:inline set:html={designThemeStyleSheet(theme)} />
<Fragment set:html={designFontsHead(await runtime.designPresets())} />
designFontsHead(presets, { root? }) 返回,顺序:最多2个
<link rel="preload" as="font" type="font/woff2" href="…" crossorigin> 联 合 国
面对 GQ 设计标记( 文本样式的主要拉丁文文件); a
<style data-gqd-fonts> 与 @font-face 规则font-display 作为
交付, swap 从 GQ 设计,倒置面和指定槽'
--gqd-font-* 堆栈;和 a <style data-gqd-text-styles> 带文字
样式 root (默认) .gqd-content,主题的根). GQ 设计集
打开槽堆栈 :root 和双倍根数:root,.gqd-content.gqd-content, (中文(简体) ),
因为主题样式表宣布系统堆栈在那里。 一个错误的存储
文本样式值被删除,而不是页失败。 它是空的,没有字体或文字样式,或者没有
家庭事务 字体 URL 仅来自预设: 有相对 URL 或 相片
在 Google 主机上的文件被删除, 因此访问者的浏览器从不联系
谷歌报. 媒体主机对跨源字体文件需要公开的 CORS 规则.
designFontStyleSheet, (中文(简体) ), designFontPreloads (链接另一个描述符)
序列器)和 designTextStyleSheet 还原部件.
presentationHtml(name, shell, presentation, { attributes, model? }) 装饰
已有根外壳。 传递本地组布局的完整块属性
上下文. presentationVariables 带有相同的属性上下文。 两名代表
对捆绑的渲染器进行验证和响应规则;保存的变量存活
当解析属性缺失时。 可选扩展 model 也必须是
转到相应的 cononic 样式表生成器.
renderDesignPattern 恢复本地文本/列表结构、媒体和布局
包装、 已解析的导航和查询组成 。 站点 options.blocks
渲染器仍然优先。 完整保存的媒体 HTML 保持权威;
仅使用源的图像节点 renderDesignImage。公共低级 HTML
适配器还支持解析站点适配器,无需二次演示解析.
木马用途 renderDesignCarousel(attributes, orderedChildren, shell?)时
儿童携带 { name, attributes, html } 和每个 html 是一个完整的
孩子们 尽管 WordPress 保存其 HTML , 但提供精确一个导航孩子
无效. renderDesignCarouselItem 接受它带来的前台儿童
可选保存的图外壳。 释放 designCarouselStyle() 一次 一次吗 视频英雄
用途 renderDesignVideoHero 和峡谷 videoHeroStyleSheet(); 推迟
iframe 仍然保留 data-src 直到同意和动议的偏好允许回放.
导航用途 navigationStyleSheet(theme) 用于交互几何.
浏览器生命周期被隔离于 @getquick/content/design/client导出
mountDesignCarousels, (中文(简体) ), mountVideoHero 财务报告和审定财务报表 mountDesignNavigation每个返回
清理; 导航替换 DOM 后再次挂载 。 导入根会
不需要浏览器全局 。 配置的运行时门生成了英雄媒体
因此,同意钩没有被改写
再来一次.
对于生产者-解析后查询,在同步渲染器外预装:
const loaded = await runtime.preloadDesignQueryPosts(pattern, siteOrigin);
const html = runtime.renderDesignPattern(pattern, {
siteOrigin,
resolvePost: loaded.resolvePost,
});
使用现有的 publishedEntry(item.uri) 改为标准员额/Page
页:1 其可选 databaseId 和犬类 designBlocks 成为已键入
DesignPostContext 结束 designPostContext旧出版物,无
中性树不能提供上下文。 自定义邮站类型需要明确
授权预装记录通过 preloadDesignQueryPosts(pattern, load)· ;
此 API 没有添加自定义的邮件类型 GraphQL 字段或查询选择引擎 .
已交付的项目顺序、计数和重复保存而不应用查询
争吵。 同步引用后不添加布局包装, 邮递内容
递归使匹配的预装中性块.
原生装饰 覆盖背景 使用相同的显式 Site 生命周期 :
import { mountDesignCoverVideos } from "@getquick/content/design/client";
const cleanup = mountDesignCoverVideos(document);
// Invoke cleanup before removing/replacing the rendered page; remount afterward.
已配置的出版物交付和 presentationHtml("core/cover", ...)
清除渴望 autoplay 从直接本地封面背景视频。 启动器
当减少的运动关闭时播放, 启用时暂停, 禁用时恢复,
并暂停/取消其在清理方面的偏好听众。 它没有前景
或普通内容视频。 如果一个站点在这些路径外生成原始封面 HTML,
应用 enhanceDesignCoverVideosHtml(html) 在苏维埃社会主义共和国之前 来源、海报和订购
前景仍然是权威性的;没有推断出遗留的外观属性.
mountDesignNavigation 还可以加强内部的原生Polylang下降
.wp-block-polylang-language-switcher,包括普通出版的 HTML 其
内置控制器在交付时被移除。 它通向交付的
选中选项的 HTTP( S) URL; 它不解析语言或评价内在
剧本. 清除清除处理器并恢复原选择.
标准 WordPress 站点列表
await content.listPosts({ page: 1, perPage: 12, language: "pt" }) 列表
标准出版的WordPress 文章,来自出版商店,最先更新
(以URI为断接器). 所有参数都是可选的; pagination 和
语言使用与 search。结果为
{ kind: "found", content: { items, total, page, perPage, totalPages } }
或者说 { kind: "unavailable", failure }. 运载罐装的物品 uri,纯文本
title,一个有界限的纯文本 excerpt,以及 language。打开文本.
使用 total,而不是当前页面的长度,以决定新闻是否存在.
与收藏不同,标准帖不需要收藏申报. 这个
运行时间记录 postType 在新读取的标准条目上。 旧出版物
仍然可读,但无法区分文章和页面:列出返回
unavailable 直到这些条目被刷新或旋转通过
调和。 这是添加剂; 没有 SQL 迁移或 CMS 插件更改
需要帮助。 现有的出版资格和退出处理适用.
无法读取的条目, 缺少共享准备行, 缺少绑定和存储
失败不能报告为零员额。 探访从不读CMS.
对于 Notícias 的收养, 升级为包含此 API 的发行对子, 刷新 存储的条目(或允许调节的旋转重读完成), 并确立正常的完全储存准备状态,然后才能列入清单. 结果描述了出版商店,而不是同步的目录 CMS:运营商必须完成初始总量并保持交付/和解 运行中。 第757页,保护英雄,并将名单列在下面:
const news = await content.listPosts({ page: requestedPage, perPage: 12, language: "pt" });
if (news.kind === "unavailable") {
// Return the Site's unavailable response (503); do not claim there is no news.
} else if (news.content.total === 0) {
// Render exactly: Brevemente disponível
} else {
// Render news.content.items and pagination; omit the placeholder.
}
超过最后页的一页没有项目,但保留了正总数; 处理 而不是空头新闻 诺米亚拥有这种渲染及其 部署; 这里没有插入 CMS 页面内容中的列表或占位符 .