前言
众所周知,phpstorm是一个非常易用的PHP的IDE,而wordpress则是一款比较常见的博客后台。这里就可以使用PHPStorm来开发wordpress(比如插件,主题以及核心)。
把wordpress集成到一个现存的PHPStorm工程
你可以这样创建一个WordPress插件工程。
当你就绪的工程被认为是wordPress的插件的时候,你就能够在事件日志(Event Log)中启用对于WordPress的支持。
你需要提供WordPress的一个安装路径(也就是WordPress的根目录,里面需要包含wp-admin和wp-include这两个子文件夹)
WordPress集成可以在Setting/WordPress
下设置:
而在我的PHPStorm里是这样的:
创建一个WordPress的新插件
新的WordPress插件可以在欢迎屏幕中通过选择File | New Project
来创建。
工程类型应该被设置为WordPress Plugin。在点到OK之后,你需要提供WordPress的安装路径。
初始的插件文件就会被自动创建(插件名称和一个合适的元信息摘要)
开发环境的配置
不管你是否做了上面的事情,IDE都会检查开发环境是否为WordPress开发所正确配置。如果配置不满足要求的话,气泡就会弹出一个修复的建议。
路径配置
你所处于的wp-content
文件夹和插件需要都在WordPress安装文件夹之外。为了利用PHPStorm的智能代码,代码补全还有其他特征,WordPress的安装文件夹需要包含在外部引用中。只要WordPress安装路径在WordPress集成配置之中提供了,IDE把WordPress安装路径添加到你工程的Include Path
之中。
你也可以在Setting | PHP | Include Path
中变更Include Path:
在这个使用案例之中,WordPress安装路径需要被添加到一个外部库之中(此时所有WordPress核心文件夹都被索引了),但是其他的插件和主题默认是不会被添加了,并且为了把他们安装到Settings | PHP | Include path
之中。
内容根目录配置
如果你开发的WordPress插件安装在WordPress安装文件夹之中,IDE就会建议把整个WordPress安装目录加到目录之中接着移除初始文件根目录。
内容目录也可以在Setting | Directories
中设置:
WordPress代码风格
当WordPress集成被启用之后,你就能够基于代码格式来设置WordPress的代码风格。
代码风格可以在Setting | Code Style | PHP 中重新配置。
WordPress钩子函数的支持
WordPress的action和filter函数参数的补齐
所有在WordPress核心函数以及插件的钩子函数都会被IDE检索,并且钩子名称也可以使用Ctrl+Space来补齐add_action
和add_filter
的参数。
action和filter钩子函数的导航
从WordPress的钩子注册中你从一个导航图标可以寻找到其来源。
你可以在特定的一行中找到来源:
钩子函数注册的回调函数
第二个钩子函数参数如果被声明是一个函数(add_action
和add_filter
)的话,你可以使用Ctrl+B
或者Ctrl+单击
来查看这个函数的来源。
你可以点击这个名称到相关函数的声明处。
钩子函数的导航
通过在Ctrl+Alt+Shift+N
键(Navigate | Symbol
),你就能够轻松的搜索钩子并且轻松的找到他们。
你也可以使用双击Shift
来找到钩子函数。如果有必要的话,同样需要确保开启纳入非工程文件选项。
找到钩子注册函数的用法
你也可以使用Alt+F7
来找到钩子函数的用法,这样会提供一系列可能的选项(在find usage of XXX
中找到)
从WordPress.org上找到详情
WordPress文档可以在IDE通过搜索文档上得到消息,你需要做的仅仅是选择你所需要的文本,右键转到Search on WordPress.org
就可以了。
默认浏览器也能够接受到IDE的请求,并且访问请求