README

从WordPress文章中添加、更新和删除图片。

需求
安装
可用方法
快速入门
用法
测试
赞助商
许可证

需求

此库支持PHP版本5.6或更高版本，且与HHVM版本3.0或更高版本兼容。

安装

安装此扩展的首选方式是通过Composer。

要安装<强>WP_Image库，只需

composer require josantonius/wp-image-handler

此命令只会安装必要的文件，如果您想<强>下载整个源代码，可以使用

composer require josantonius/wp-image-handler --prefer-source

您还可以使用Git <强>克隆完整仓库

git clone https://github.com/josantonius/wp-image-handler.git

或 <强>手动安装

下载WP_Image.php:

wget https://raw.githubusercontent.com/josantonius/wp-image-handler/master/src/class-wp-image.php

可用方法

此库中的可用方法

- 保存图片并将其与特定文章相关联

WP_Image::save($url, $post_ID, $featured);

属性	描述	类型	必需	默认
$url	外部url图片。	字符串	是
$post_ID	文章ID。	整数	是
$featured	设置图片为特色。	布尔型	否	false

<强>返回 (string|false) → 附件文件的URI或失败时返回false。

- 将图片上传到WordPress上传目录

WP_Image::upload($url, $filename);

属性	描述	类型	必需
$url	外部url图片。	字符串	是
$filename	文件名。	字符串	是

<强>返回 (string|false) → 上传图片的路径或失败时返回false。

- 删除附件及其所有衍生文件

WP_Image::delete_all_attachment($post_ID, $force);

属性	描述	类型	必需
$post_ID	文章ID。	整数	是
$force	强制删除。	布尔型	是

<强>返回 (int|false) → 删除的附件。

快速入门

要使用此库与<强>Composer

require __DIR__ . '/vendor/autoload.php';

use Josantonius\WP_Image;

如果您已<强>手动安装，请使用它

require_once __DIR__ . '/class-wp-image.php';

use Josantonius\WP_Image\WP_Image;

用法

此库使用示例

- 上传图片

WP_Image::upload('https://site.com/image.png', 'image.png');

- 保存图片

WP_Image::upload('https://site.com/image.png', '18');

- 保存特色图片

WP_Image::upload('https://site.com/image.png', '18', true);

- 删除附件

WP_Image::delete_all_attachment(18);

- 强制删除附件

WP_Image::delete_all_attachment('18', true);

测试

要运行测试，您只需要Composer并执行以下命令

git clone https://github.com/josantonius/wp-image-handler.git

cd WP_Image

bash bin/install-wp-tests.sh wordpress_test root '' localhost latest

composer install

使用PHPUnit运行单元测试

composer phpunit

使用WordPress代码规范测试与PHPCS

composer phpcs

运行PHP Mess Detector测试以检测代码风格的不一致性

composer phpmd

运行所有之前的测试

composer tests

赞助商

如果这个项目帮助您减少了开发时间，您可以赞助我以支持我的开源工作 😊

许可证

此存储库在MIT许可证下许可。

josantonius / wp-image-handler

维护者

详细信息