aaemnnosttv / wp-cli-login-command
使用安全无密码的魔法链接登录WordPress。
Requires
- php: ^5.6 || ^7.0 || ^8.0
- composer/semver: ^1 || ^2 || ^3
Requires (Dev)
- phpunit/phpunit: ^5 || ^6 || ^7 || ^8 || ^9
- wp-cli/entity-command: ^2
- wp-cli/extension-command: ^2
- wp-cli/server-command: ^2
- wp-cli/wp-cli-tests: ^3.0
README
使用安全无密码链接登录WordPress。
使用
NAME
wp login
DESCRIPTION
Manage magic passwordless sign-in.
SYNOPSIS
wp login <command>
SUBCOMMANDS
create Create a magic sign-in link for the given user.
email Email a magic sign-in link to the given user.
install Install/update the companion server plugin.
invalidate Invalidate any existing magic links.
toggle Toggle the active state of the companion server plugin.
create
/ as
wp login create <user> [options]
或者使用别名
wp login as <user> [options]
为指定用户创建一个魔法登录链接。输出创建的URL和一些有关使用和到期时间的额外信息。URL在创建后15分钟过期(可配置),或者在使用时过期,以先到者为准。
<user>
可以作为用户ID、用户名/登录名或电子邮件地址传递。这对于所有接受此作为参数的login
命令都一样。
--expires=<seconds>
设置魔法链接的有效期(以秒为单位)。
10 minutes = 600
1 hour = 3600
1 day = 86400
默认值:900
(15分钟)
--redirect-url=<url>
设置成功登录后重定向到的URL。默认为admin_url()
。
注意:重定向是通过使用
wp_safe_redirect
执行的,该函数使用允许的主机列表限制目标URL。默认情况下,这限制在网站的域名内,但可以使用allowed_redirect_hosts
过滤器进行扩展。
--url-only
仅输出创建的登录URL。非常适合脚本、复制到剪贴板或其他任何您能想到的事情。
--launch
在创建后立即在默认浏览器中打开登录链接。这是登录最快的方式。
email
wp login email <user> [options]
将魔法登录链接通过电子邮件发送给指定用户。向用户的电子邮件地址发送包含他们刚刚创建的魔法登录链接的精美HTML电子邮件。计划未来添加对HTML和纯文本电子邮件的支持。
--expires=<seconds>
--redirect-url=<url>
--subject=<email-subject>
可选地使用您自己的自定义字符串覆盖默认电子邮件主题。您可以使用{{ domain }}
占位符。
默认值:{{domain}}的魔法登录链接
--template=<path-to-custom-template>
可选地通过提供要使用的不同模板文件的路径来覆盖默认电子邮件模板。电子邮件模板使用Mustache模板引擎进行编译,因此您可以在自定义模板中使用{{ magic_url }}
和{{ domain }}
占位符。默认模板可以在本存储库中的template/email-default.mustache
下找到。
install
wp login install [options]
安装/更新配套服务器插件。在主机上使用魔法链接之前,需要安装配套插件。该login
命令知道插件的安装版本,如果需要,会通知您进行安装、激活或升级。如果插件已经安装,则会提示您覆盖它。
--activate
可选地立即在安装后激活插件。
--mu
作为必需插件安装。
--yes
抑制覆盖现有插件的确认提示。
使用基于Composer的WordPress安装?您可以使用包
aaemnnosttv/wp-cli-login-server
来要求安装辅助插件。
使无效
wp login invalidate
使任何现有的魔法登录链接无效。之前创建的链接很可能会跳转到404页面。
切换
wp login toggle [<on|off>]
切换辅助插件的激活状态。可选地传递on
或off
以相应地设置激活。如果没有传递,状态将简单地反转。
安装
安装此包需要WP-CLI v0.23.0或更高版本。使用wp cli update
更新到最新稳定版本。
完成后,您可以使用wp package install aaemnnosttv/wp-cli-login-command
安装此包。
贡献
我们感谢您主动为这个项目做出贡献。
贡献不仅限于代码。我们鼓励您根据自己的能力以最佳方式做出贡献,例如编写教程、在当地聚会中展示、帮助其他用户解答支持问题或修订我们的文档。
报告一个错误
你认为你发现了一个错误?我们很高兴你能帮助我们修复它。
在创建新问题之前,你应该搜索现有问题,看看是否有针对该错误的现有解决方案,或者它是否已经在更新的版本中修复。
在你搜索之后,发现没有针对你的错误的开放或已修复问题,请创建一个新的问题,并包括以下内容
- 你所做的事情(例如:“当我运行
wp post list
”)。 - 你所看到的内容(例如:“我看到一个关于类未定义的致命错误。”)。
- 你期望看到的内容(例如:“我期望看到文章列表。”)
尽可能提供详细信息,如果可能的话,包括重现问题的清晰步骤。
创建一个拉取请求
想要贡献一个新功能?请首先创建一个新问题,讨论该功能是否适合项目。
一旦你决定投入时间来完成你的拉取请求,请遵循我们创建拉取请求的指南,以确保它是一个愉快的体验。
- 为每次贡献创建一个功能分支。
- 提前提交你的拉取请求以获取反馈。
- 将功能测试与你的更改一起提交。阅读WP-CLI文档以获取介绍。
- 遵循PSR-2编码标准。