real-coder-pty-ltd/do-spaces-sync-rc

This WordPress plugin syncs your media library with DigitalOcean Spaces Container.

1.0.7 2024-10-18 07:58 UTC

Requires

• php: >=5.3.3
• league/flysystem-aws-s3-v3: ^3.8
• spatie/image-optimizer: ^1.1

MIT

• Matt Neal

• storage
• s3
• aws
• cloudfiles
• digitalocean
• spaces

README

This plugin is a fork from https://github.com/keeross/DO-Spaces-Wordpress-Sync It works for php 7.X.X and allows to sync your Wordpress media library with DigitalOcean Spaces Container.

Description

This WordPress plugin syncs your media library with DigitalOcean Spaces Container. It allows you to simuntanously upload and delete files, replacing public media URL with relative cloud storage links. You can choose between two options, to keep local copy of the files, or to delete them and keep files only in cloud storage.

In order to use this plugin, you have to create a DigitalOcean Spaces API key.

You may now define constants in order to configure the plugin. If the constant is defined, it overwrites the value from settings page. Contants description:

• DOS_KEY - DigitalOcean Spaces key
• DOS_SECRET - DigitalOcean Spaces secret,
• DOS_ENDPOINT - DigitalOcean Spaces endpoint,
• DOS_CONTAINER - DigitalOcean Spaces container,
• DOS_STORAGE_PATH - The path to the file in the storage, will appear as a prefix,
• DOS_STORAGE_FILE_ONLY - Keep files only in DigitalOcean Spaces or not, values (true|false),
• DOS_STORAGE_FILE_DELETE - Remove files in DigitalOcean Spaces on delete or not, values (true|false),
• DOS_FILTER - A Regex filter,
• UPLOAD_URL_PATH - A full url to the files, WP Constant,
• UPLOAD_PATH - A path to the local files, WP Constant

There is a known issue with the built in Wordpress Image Editor, it will not upload changed images. Know how to fix this, PR welcome.

Installation

1. Upload plugin directory to /wp-content/plugins/
2. Activate plugin through 'Plugins' menu in WordPress
3. Go to Settings -> DigitalOcean Spaces Sync and set up plugin

If plugin has been downloaded from GitHub, you have to install vendor components via composer update.

Image Handling "Best Practices"

Configure settings -> media sizes based on the websites' design requirements (thumb max size, hero image max size, etc.). Add additional sizes if required via registering new sizes hooks.

Use WordPress native features to get images attached to a listing via get_the_post_thumbnail() eg:

<?php echo get_the_post_thumbnail($property->post->ID, 'medium'); ?>

Get attached media via:

$attachments = get_attached_media('image', $property->post->ID);
$media = [];

// Get the attachment IDs.
foreach ($attachments as $attachment) {
	$media[] = $attachment->ID;
}

For the gallery, loop over your media and output the images via WP native functionality like so:

wp_get_attachment_image( $attachment_id, $size, $icon, $attr );

working example:

foreach($attachments as $attachment) {
	echo wp_get_attachment_image( $attachment->ID, $size, false, ['class' => 'gallery-image'] );
}