automattic/jetpack-forms

Jetpack Forms

安装数: 5,906

依赖项: 1

建议者: 0

安全性: 0

星级: 1

关注者: 3

分支: 0

类型:jetpack-library

v0.32.16 2024-09-16 14:37 UTC

README

所有与表单相关的内容。此软件包目前包含Jetpack联系表单模块、表单块以及新的Jetpack Forms反馈仪表板。

层次结构

.
├── src/
│   ├── blocks/                                      - Form blocks.
│   ├── contact-form/                                - Contact form module implementation.
│   ├── dashboard/                                   - Implementation for the new forms dashboard.
│   ├── service/                                     - Helpers for 3rd-party service integrations.
│   ├── class-jetpack-forms.php                      - Package entrypoint.
│   └── class-wpcom-rest-api-v2-endpoint-forms.php   - WP.com REST API endpoints definition.
│
└── tools/                                           - Webpack configuration for all bundles in the package.

查看各个子目录以获取更多信息。

API端点

此软件包添加以下WP.com REST API端点

GET /forms/responses

返回联系表单响应列表。

支持的参数

  • parent_id: (int) 通过父帖ID过滤响应。
  • limit: (int) 限制返回响应的数量。
  • month: (string) 通过月份过滤响应。格式:YYYYMM
  • offset: (int) 偏移返回的响应。
  • search: (string) 搜索包含给定字符串的任何字段的响应。
  • status: (string) 通过状态过滤响应。支持值:inboxspamtrash

响应

{
    "filters_available": {
        "month": [
            { "month": 1, "year": 2023 },
            { "month": 3, "year": 2023 },
        ],
        "source": [
            {
                "id": 55,
                "title": "Contact Page",
                "url": "https://jetpackme.wordpress.com/contact-support",
            }
        ],
    },
    "responses": [
        {
            "id": 123,
            "entry_permalink": "https://jetpackme.wordpress.com/contact-support",
            "entry_title": "Contact Page",
            "ip": "127.0.0.1",
            "date": "2023-01-05T00:00:00",
            "fields": {
                "1_Name": "John Smith",
                "2_Email": "[email protected]",
                "3_Message": "Help!",
            },
        },
        {
            "id": 213,
            "entry_permalink": "https://jetpackme.wordpress.com/contact-support",
            "entry_title": "Contact Page",
            "ip": "127.0.0.1",
            "date": "2023-03-20T05:23:00",
            "fields": {
                "1_Name": "John Smith",
                "2_Email": "[email protected]",
                "3_Message": "Lorem Ipsum",
            },
        },
    ],
    "totals": {
        "inbox": 2,
        "spam": 0,
        "trash": 1,
    },
}

POST /forms/responses/bulk_actions

对响应ID列表执行批量操作。

支持的参数

  • action: (string) 要执行的操作。支持值:mark_as_spammark_as_not_spamtrashuntrashdelete(永久删除响应)。
  • post_ids: (int[]) 要执行操作的响应ID列表。

响应

{}

在WordPress插件中使用此软件包

如果您计划在WordPress插件中使用此软件包,我们建议您使用 Jetpack Autoloader 作为自动加载器。这将允许与其他使用此软件包的插件实现最大兼容性。

安全性

需要报告安全漏洞?请访问 https://automattic.com/security/ 或直接访问我们的安全漏洞赏金网站 https://hackerone.com/automattic

许可证

forms 适用于 GNU通用公共许可证第2版(或更高版本)