README

此 WordPress 插件添加了几个短代码，允许用户编辑其在 CiviCRM 中的个人资料或组织。

注意：短代码生成的 HTML 代码未加样式。您需要根据主题调整 CSS。

要求

您需要 CiviCRM 5.6。

可用短代码

警告:

• 不要在同一页上添加多个短代码。
• 可以动态使用 civicrm_action 查询变量替换短代码。因此，即使您没有使用短代码，用户也可能能够访问此功能。

edit_member

显示一个表单，允许已登录用户编辑其联系信息。

属性

• id：要编辑的人的 CiviCRM ID。默认为当前用户。（也可以使用 civicrm_id 查询变量设置。）

edit_organization

显示一个表单，允许已登录用户编辑组织信息。用户必须与组织有联系，并且必须允许编辑。

属性

• id：要编辑的组织的 CiviCRM ID。（也可以使用 civicrm_id 查询变量设置。）
• tagset（可选）：用户可以从中选择应用于组织的标签的标签集名称。
• note（可选）：可以创建在组织上并公开显示的备注名称，与 show_organization 一起显示。（例如，可以用作公开描述。）

show_organization

显示有关组织的详细信息。

属性

• id：要显示的组织的 CiviCRM ID。（也可以使用 civicrm_id 查询变量设置。）
• tagset（可选）：显示应用于组织的标签的标签集名称。
• note（可选）：附加到组织的备注名称（如果存在），将显示。

search_organization

显示一个表单，允许搜索组织。

属性

• redirect（可选）：表单应重定向到的页面 URL。（如果您想在主页上显示表单但结果显示在另一个也包含此短代码的单独页面上，这可能很有用。）
• country（可选）：列出省的国家的 ISO 代码。
• tagset（可选）：从中显示搜索组织的标签的标签集名称。

show_members

显示组织的成员。用户还必须是组织的成员。请小心处理 GDPR，如果任何人都可以不加监管地加入任何组织，则您可能不合规。

属性

• id：要编辑的组织的 CiviCRM ID。（也可以使用 civicrm_id 查询变量设置。）

show_member

显示有关个人的信息。

属性

• id：要显示的人的 CiviCRM ID。默认为当前用户。（也可以使用 civicrm_id 查询变量设置。）

add_organization

允许已登录用户在自身与组织之间建立关系。

create_organization

允许已登录用户创建新组织。

属性

• tagset（可选）：用户可以从中选择应用于组织的标签的标签集名称。
• note（可选）：可以创建在组织上并公开显示的备注名称，与 show_organization 一起显示。（例如，可以用作公开描述。）

add_member

显示一个表单，允许已登录用户在个人和组织之间建立关系。用户必须与组织有联系，并且必须允许编辑。

属性

• id：组织的 CiviCRM ID。（也可以使用 civicrm_id 查询变量设置。）

edit_relationship

显示一个表单，允许已登录用户编辑关系。

属性

• id：要编辑的关系的 CiviCRM ID。（也可以使用 civicrm_id 查询变量设置。）

edit_avatar

显示一个表单，允许已登录用户更改自己的头像。

必须启用WP User Avatar插件。

delete_member

显示一个页面，允许登录用户删除账户。如果用户确认，WordPress账户将被删除，但不会删除CiviCRM个人资料。

(目前，用户只能删除自己的账户。)

属性

• id：要删除账户的人的CiviCRM ID。默认为当前用户。(也可以通过civicrm_id查询变量设置。)

Grunt任务

Grunt可用于运行在Gruntfile.js中定义的一些自动化任务。

首先需要使用Yarn和Composer安装依赖项。

yarn install
composer install

注意不要将这些依赖项提交到仓库中！

您可以通过以下方式删除它们

composer install --no-dev

(我们无法将vendor/添加到.gitignore中，因为我们需要将非开发依赖项和自动加载器包含到仓库中，以防插件使用常规WordPress安装程序而不是Composer安装。)

代码格式化检查

您可以检查JavaScript、JSON和PHP文件是否格式正确。

grunt lint

测试

您可以运行PHPUnit测试。

grunt test

文档

可以使用phpDocumentor生成代码文档。

grunt doc

CI

使用Gitlab CI在每次提交后自动运行测试。