出于安全考虑,WordPress 内容中禁止运行 PHP;为了允许与内容进行动态交互,WordPress 2.5 版本引入了短代码(Shortcodes)。
短代码是一种宏,可用于对内容进行动态交互。例如,从附件到帖子的图片创建画廊或渲染视频。
为什么使用短代码?
短代码是一种有价值的方式,可以在保持内容干净和语义的同时,允许最终用户以编程方式更改其内容的呈现方式。
当最终用户使用短代码在帖子中添加照片画廊时,他们使用最少量的数据来指示如何呈现该画廊。
优势:
- 不会向帖子内容添加标记(markup),这意味着标记和样式可以轻松地进行即时或稍后的操作。
- 短代码还可以接受参数,允许用户逐个实例地修改短代码的行为。
内置短代码
默认情况下,WordPress 包含以下短代码:
[caption]– 允许您为内容添加说明文字[gallery]– 允许您显示图片画廊[audio]– 允许您嵌入和播放音频文件[video]– 允许您嵌入和播放视频文件[playlist]– 允许您显示音频或视频文件的集合[embed]– 允许您包裹嵌入式项目
短代码最佳实践
开发短代码的最佳实践包括 插件开发最佳实践 以及以下内容:
- 始终返回值!
短代码本质上是过滤器,因此创建“副作用”会导致意外的错误。 - 为短代码名称添加前缀,以避免与其他插件发生冲突。
- 清理输入并转义输出。
- 为用户提供所有短代码属性的清晰文档说明。
快速参考
查看使用 基本短代码结构 的完整示例,包括处理自闭合和包围场景、短代码中的短代码以及保护输出。