Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Tim Gieseking committed Jun 6, 2019
1 parent aed71fe commit b1952e4
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
# Distributor / Yoast Sync

Extends the [Distributor plugin](https://github.com/10up/distributor) by 10up to sync Yoast SEO social images between sites.
Extends the [Distributor plugin](https://github.com/10up/distributor) by 10up to sync Yoast SEO settings more properly. This plugin adds 2 primary enhancements:

This plugin has only been tested with Distributor 1.4.1 and is intended for use with EXTERNAL connections only.
1. Social images set in Yoast are fixed when pushed or pulled to another site. The image IDs are pointed to the correct local image by looking for a `dt_original_media_id` meta value.
2. When updating a post, Yoast meta fields save AFTER updates are synced to a connected post. This means you have to hit 'Update' twice to sync your new meta data. This plugin solves by updating the meta data with new Yoast information prior to it being synced.

When a post is pushed or pulled, this plugin will try to match \_yoast_wpseo_opengraph-image-id (and \_yoast_wpseo_twitter-image-id) with any attachment having the key dt_original_media_id and the value from these yoast fields. If one is found, it will set the yoast custom fields to the new attachment ID, and update the yoast custom fields with the correct URLs for those attachments.
This plugin has only been tested with Distributor 1.4.1 and is intended for use with **EXTERNAL connections only.**

### Known Issues

- This plugin does not integrate with the "Meta robots advanced" settings in Yoast. If you use these settings, you'll need to still update twice to sync to your connected post.
- This plugin does not integrate with the "Canonical URL" setting in Yoast; Distributor already has its own logic built in to handle canonical URLs.

0 comments on commit b1952e4

Please sign in to comment.