hsimah-services/wp-graphql-metabox

Metabox 对 WPGraphQL 的集成

安装次数: 66

依赖者: 0

建议者: 0

安全: 0

星标: 24

关注者: 6

分支: 4

开放问题: 8

类型:wordpress-plugin

0.4.0 2021-01-04 21:44 UTC

This package is auto-updated.

Last update: 2024-09-11 05:02:19 UTC


README

快速安装

像安装任何 WordPress 插件一样下载并安装。

文档

WPGraphQL 文档可以在这里找到。

  • 需要 PHP 7.3+
  • 需要 WordPress 5.4+
  • 需要 WPGraphQL 1.1.3+
  • 需要 Meta Box 5.3.8+
    • 需要 MB User Meta 扩展以使用用户字段

概述

此插件为 Meta BoxWPGraphQL 提供集成。

通过简单地在字段注册中添加一个额外的 graphql_name 属性,该字段将暴露在 GraphQL 架构中。

用法

此示例假设您知道如何在 WPGraphQL 中暴露自定义帖子类型 - 阅读他们的文档以获取更多信息。

使用 Meta Box,定义一个自定义字段。将生成的代码复制并粘贴到您的 functions.php(或您存储自定义代码的任何地方)。

wp-graphql-metabox 选项

在字段定义中添加 graphql_name

$meta_boxes[] = [
    'title' => 'Extra Fields',
    'id' => 'extra-fields',
    'post_types' => [
        0 => 'post',
    ],
    'context' => 'after_title',
    'priority' => 'high',
    'autosave' => true,
    'fields' => [
        [
            'id' => 'a_random_number',
            'name' => 'A Random Number',
            'type' => 'number',
            'std' => 5,
            'columns' => 2,
            'size' => 3,
            'graphql_name' => 'randomNumber',
            'graphql_mutate' => true
        ],
    ],
];

就是这样。字段 randomNumber 将在类型 post 上暴露。这将适用于您可能创建的任何自定义帖子类型。

注意:您必须通过向 CPT 配置中添加 show_in_graphql 来暴露自定义类型。

一个简单的查询可能如下所示

query {
    posts {
        nodes {
            title
            content
            randomNumber
        }
    }
}

限制

目前,此插件仅支持在 postuser 类型上自定义字段(即没有设置页面)。

目前,此插件仅支持以下 Meta Box 类型

  • 分类
  • 高级分类
  • 开关
  • 复选框
  • 复选框列表
  • 背景
  • 颜色
  • 自定义 HTML
  • 日期
  • 标题
  • 日期时间
  • 嵌入
  • 密码
  • 单选按钮
  • 多行文本框
  • 时间
  • 选择
  • 电子邮件
  • 电话
  • 文本
  • 网址
  • 富文本编辑器
  • 字段集文本
  • 高级选择
  • 文本列表
  • 键值对
  • 数字
  • 范围
  • 单张图片
  • 用户
  • 帖子
  • group 如果您需要一个不受支持的字段,请随时提交问题(或者更好的是,提交 PR!)