进阶 docs.flarum.org 2026-10-15 14:50:53 · 19 阅读
第40章 Flarum 第40章：Nicknames（昵称）扩展详解
版本：2.xNicknames（昵称）
Nicknames 扩展（flarum/nicknames）允许成员设置一个昵称，论坛中将以昵称取代用户名显示。用户名本身保持不变，登录时仍然使用用户名。该扩展随 Flarum 内置提供，但默认处于禁用状态。
昵称可以使用用户名中不允许的字符（比如空格），因此成员可以用真实姓名或自定义的显示名称。
将显示名称切换为昵称仅启用扩展还不够。你还需要在管理后台的「基本设置」页面中，将「用户显示名称」设置为「昵称」。否则昵称不会显示，成员也无从设置。在此之前，扩展的设置页面会一直显示提醒。
安装该扩展随 Flarum 内置提供，但默认未启用。在管理后台的「扩展」页面中启用它，然后按照上面的说明在「基本设置」页面修改显示名称。
如果你的安装中缺少该扩展，可以像安装其他包一样引入：
composer require flarum/nicknames
php flarum migrate
php flarum cache:clear
Settings 设置默认值描述在注册时允许设置昵称开在注册表单中添加昵称字段。随机化用户名关闭从注册表单中移除用户名字段，并将昵称设为必填项。参见随机用户名。要求昵称唯一关闭昵称必须与其他所有成员的昵称和用户名不同。验证用的正则表达式空每个昵称都必须匹配的字符模式。输入模式时不要带定界符：^a-zA-Z +$，而不是 /a-zA-Z +$/. 留空则允许任意字符。昵称最小长度 1留空或设为 0 表示无下限。昵称最大长度 150留空或设为 0 表示无上限。 无论字符模式如何允许，昵称永远不能包含 []、<>。这些字符可能导致在通知邮件中将名称误判为链接。任何违反这些规则的昵称都将被拒绝，并显示一条通用消息，提示成员联系论坛管理员。 权限 该扩展在管理员后台的权限页创建分类下添加一项权限。 权限默认值描述编辑自己的昵称成员允许用户在个人设置页中通过“修改昵称”功能更改自己的昵称。 拥有核心“编辑用户属性”权限的任何用户，均可在“编辑用户”对话框中修改该用户的昵称。 昵称的显示方式 当显示名称设为昵称时，已设置昵称的成员在其名称出现的所有位置（包括邮件中）都会显示昵称。未设置昵称的成员则显示用户名。 将昵称设为与用户名相同的值会删除该昵称。 搜索用户时会同时匹配昵称和用户名。 随机用户名 开启随机化用户名后，新成员无需选择用户名。注册表单仅要求填写昵称（必填），系统会分配类似 user_a3f7b2c9 的用户名。由于所有人均可见昵称，成员无需知晓该用户名。 此功能仅在“注册时允许设置昵称”也开启时生效。若该选项关闭，注册表单将保留用户名输入框。 从 Flarum 1.x 升级的论坛 Flarum 1.x 通过此方式注册的用户，其用户名仅为纯数字，例如 38275019461204937561。Flarum 2.0 不再允许新账户使用此类用户名，但老成员保留原有用户名。自 Flarum 2.0.1 起，可将其转换为当前格式： php flarum nicknames:convert-legacy-usernames 该命令会重命名所有同时拥有昵称和全数字用户名的成员。执行前，它会显示符合条件的成员数量，并要求你确认。那些只有全数字用户名但没有昵称的成员则保持原样：该用户名是它们的显示名称，且可用于登录。命令会告知你这类成员的数量，以便你手动处理它们的名称。 选项说明 --dry-run 仅统计会被重命名的成员数量。 --force 跳过确认直接执行重命名，适用于脚本环境。 在大型论坛中，重命名操作耗时较长。你可以随时停止并重新运行该命令，它会继续处理尚未重命名的成员。 执行前请注意： 若你的个人资料链接使用用户名（默认设置），指向这些成员的个人主页链接将失效，旧链接不再有效； 原本使用旧用户名登录的成员需改用邮箱地址或新用户名登录； 帖子内容和提及记录不受影响，因为它们通过成员 ID 而非用户名进行关联。 启用 Audit 扩展后，每次重命名操作都会被记录为 user.username_changed，并包含新旧用户名。具体查看 Flarum core 在 Audit 扩展的已记录操作列表。 审计日志 启用 Audit 扩展后，昵称变更会被记录为 user.nickname_changed，包含新旧昵称。具体查看 Flarum Nicknames 在 Audit 扩展的已记录操作列表。 当 GDPR 扩展对某成员执行匿名化操作时，其昵称会被清除。
php flarum migrate
php flarum cache:clear
Settings 设置默认值描述在注册时允许设置昵称开在注册表单中添加昵称字段。随机化用户名关闭从注册表单中移除用户名字段，并将昵称设为必填项。参见随机用户名。要求昵称唯一关闭昵称必须与其他所有成员的昵称和用户名不同。验证用的正则表达式空每个昵称都必须匹配的字符模式。输入模式时不要带定界符：^a-zA-Z +$，而不是 /a-zA-Z +$/. 留空则允许任意字符。昵称最小长度 1留空或设为 0 表示无下限。昵称最大长度 150留空或设为 0 表示无上限。 无论字符模式如何允许，昵称永远不能包含 []、<>。这些字符可能导致在通知邮件中将名称误判为链接。任何违反这些规则的昵称都将被拒绝，并显示一条通用消息，提示成员联系论坛管理员。 权限 该扩展在管理员后台的权限页创建分类下添加一项权限。 权限默认值描述编辑自己的昵称成员允许用户在个人设置页中通过“修改昵称”功能更改自己的昵称。 拥有核心“编辑用户属性”权限的任何用户，均可在“编辑用户”对话框中修改该用户的昵称。 昵称的显示方式 当显示名称设为昵称时，已设置昵称的成员在其名称出现的所有位置（包括邮件中）都会显示昵称。未设置昵称的成员则显示用户名。 将昵称设为与用户名相同的值会删除该昵称。 搜索用户时会同时匹配昵称和用户名。 随机用户名 开启随机化用户名后，新成员无需选择用户名。注册表单仅要求填写昵称（必填），系统会分配类似 user_a3f7b2c9 的用户名。由于所有人均可见昵称，成员无需知晓该用户名。 此功能仅在“注册时允许设置昵称”也开启时生效。若该选项关闭，注册表单将保留用户名输入框。 从 Flarum 1.x 升级的论坛 Flarum 1.x 通过此方式注册的用户，其用户名仅为纯数字，例如 38275019461204937561。Flarum 2.0 不再允许新账户使用此类用户名，但老成员保留原有用户名。自 Flarum 2.0.1 起，可将其转换为当前格式： php flarum nicknames:convert-legacy-usernames 该命令会重命名所有同时拥有昵称和全数字用户名的成员。执行前，它会显示符合条件的成员数量，并要求你确认。那些只有全数字用户名但没有昵称的成员则保持原样：该用户名是它们的显示名称，且可用于登录。命令会告知你这类成员的数量，以便你手动处理它们的名称。 选项说明 --dry-run 仅统计会被重命名的成员数量。 --force 跳过确认直接执行重命名，适用于脚本环境。 在大型论坛中，重命名操作耗时较长。你可以随时停止并重新运行该命令，它会继续处理尚未重命名的成员。 执行前请注意： 若你的个人资料链接使用用户名（默认设置），指向这些成员的个人主页链接将失效，旧链接不再有效； 原本使用旧用户名登录的成员需改用邮箱地址或新用户名登录； 帖子内容和提及记录不受影响，因为它们通过成员 ID 而非用户名进行关联。 启用 Audit 扩展后，每次重命名操作都会被记录为 user.username_changed，并包含新旧用户名。具体查看 Flarum core 在 Audit 扩展的已记录操作列表。 审计日志 启用 Audit 扩展后，昵称变更会被记录为 user.nickname_changed，包含新旧昵称。具体查看 Flarum Nicknames 在 Audit 扩展的已记录操作列表。 当 GDPR 扩展对某成员执行匿名化操作时，其昵称会被清除。
