PhpDev.App
yiichou/aliyun-oss-support

yiichou/aliyun-oss-support

Stars: 348

Forks: 82

Pull Requests: 11

Issues: 117

Watchers: 18

Last Updated: 2023-01-18 16:04:02

#aliyun-oss #wordpress #oss-wordpress

基于阿里云OSS的WordPress远程附件支持插件

License: Other

Languages: PHP

阿里云 OSS 支持插件 (Aliyun OSS For WordPress)

本插件主要为 Wordpress 提供基于阿里云 OSS 的远程附件存储功能，并且最大限度的依赖 Wordpress 本身功能扩展来实现，以保证插件停用或博客搬迁时可以快速切换回原来的方式。

插件特色

  1. 支持 Aliyun OSS 的图片服务（根据参数获得不同尺寸的图片）
  2. 自定义文件在 Bucket 上的存储位置
  3. 支持 Https 站点
  4. 支持阿里云内网和 VPC 网络
  5. 全格式附件支持，不仅仅是图片
  6. 支持 WordPress 4.4+ 新功能 srcset，在不同分辨率设备上加载不同大小图片
  7. 支持 WordPress 5.0+ 默认古藤堡编辑器Gutenburg
  8. 支持阿里云url鉴权，实现高级别防盗链功能，支持阿里云CDN的A、B、C所有方式鉴权，推荐A方式
  9. 支持在 WordPress 后台编辑图片
  10. 支持预设图片样式，图片保护，自定义分割符
  11. 中英文双语支持，方便使用英文为默认语言的同学
  12. 支持在其他插件/主题中通过系统钩子调用插件功能
  13. 代码遵循 PSR-4 规则编写

插件使用

关于插件使用方式的 Wiki: Quick start

下载

latest release

安装

将插件解压上传到 /wp-content/plugins/ 或者通过 WordPress 插件中心上传安装

配置

启用插件 Aliyun OSS

进入设置页面 完成相关设置

  • 如果你使用的 ECS 与 OSS 在同一区域，可以开启『内网/internal』选项，节约流量
  • 『Bucket 域名/Bucket Host』一项会自动补全，也可以手动设置为你的 自定义域名 或 CDN 域名

screenshot

启用 OSS 图片服务

阿里云 OSS 提供了根据 url 参数来获得各种尺寸的 阿里云OSS图片处理服务（Image Service，简称 IMG）, 相比起 WordPress 上传的时候生成各种尺寸的图片, 这是一种更优雅的解决方案, 占用的存储空间更小, 尺寸变更更灵活。

如何开启并配置图片服务, 请参见: How to use Image Service

另外还有几点需要你了解:

  1. 开启图片服务时, 只有原图会被上传到 OSS, 缩略图本地依旧会生成但不会上传
  2. 基于第 1 条, 建议开启图片服务后就不要关了, 关掉会导致之前上传的图片缩略图无法访问（文章中的图片不受影响）
  3. 基于第 2 条, 如果你确实想关掉图片服务，参见下一项里面的解决方案

启用 CDN URL鉴权

1.阿里云URL鉴权功能由CDN服务提供，安全级别比较高，启用URL鉴权功能时，需要先在阿里云CDN控制面板-域名管理-管理-访问控制中设置鉴权方式和鉴权主/备Key，Key为完全自定义，请勿使用您的密码/AK/SK，鉴权方式推荐设置为A方式。具体设置详见什么是url防盗链

2.在阿里云控制台中设置好鉴权方式和Key之后，打开插件URL鉴权功能，填入您的鉴权方式和Key，以及您希望URL失效的时间（按小时计），即可实现URL鉴权

3.如果不希望开启URL鉴权，阿里云CDN和OSS还带有更为简单的Refer黑/白名单防盗链功能，安全性稍差且不带链接失效时间设置，详见CDN如何配置refer防盗链OSS防盗链使用指南

启用插件后，老文件无法访问

参见 WIKI：How to handle old images

关于不在本地服务器上保留文件

『不在本地服务器上保留文件』建议不要开启, 理由如下:

  1. 如果同时开启『图片服务』, 当你想停用这个插件的时候不可避免的会遇到缩略图丢失问题
  2. 如果没有同时开启『图片服务』, 当你从后台删除图片或附件时, OSS 里面的缩略图无法被删掉

题外

本插架由官方商店中 马文建(@mawenjian) 同学的「阿里云附件」插件拓展而来。由于马同学在曾经的某段时间里没能即时维护这个项目，也没有开源，于是我在修复 bug 并 rebuild 后，将这个野生的修订版发布到阿里云社区，意外获得了 ACE 社区官方管理组的推荐。

后来，马同学 release 了 2.0 版本并开源他的项目了，我就中止了这边的维护。但依旧是有网友提 Issue 或发邮件来询问，加上自己的需求，有时间的时候，也就修补一下大家反应的问题，也许还是会有人会用到。

由于插件沿用了马同学插件的名字，并 WordPress 官方不再允许在未经授权的情况下使用知名商标（如：Aliyun) 作为插件名称的一部分，所以这个插件并没有提交官方商店的计划。（重新想个名字对我来说太麻烦了~~(￣▽￣)）

更新日志

CHANGELOG.md

项目依赖

贡献代码

  1. Fork 这个仓库
  2. Clone 源码
  3. 执行 composer install
  4. 安装到本地 WordPress 中或者 执行 docker-compose up 启用一个新实例
  5. 完成你的修改并测试
  6. 提交一个 Pull Request

开源协议

BSD

OPEN ISSUES

See all

RELEASES

See all