Stored ID handling - Phase 2

[iamdharmesh]

Description of the Change

This PR is the Phase 2 of the "Stored ID handling" work we began in #1302.

It introduces a new type key in the $args parameter of distributor_register_data. This allows users to utilize the default pre/post callback functions we've implemented for common entities like posts, terms, and media. For these types of entities, users no longer need to write custom pre/post callbacks, they can simply provide the data type, location, and attribute, and the default callback functions will handle the rest.

Example:
An image ID stored in post meta under the key example_image_id would be handled like this:

distributor_register_data( 'example_post_meta_data', array(
	'location'   => 'post_meta',
	'attributes' => array(
		'meta_key' => 'example_image_id',
	),
	'type'       => 'media'
) );

How to test the Change

You can find examples of data registration using the distributor_register_data function in the documentation and the e2e-test-plugin file. But please feel free to experiment on your own for something different.

1. Check out this PR branch on both the source and target WordPress sites.
2. Register data using distributor_register_data for specific stored IDs in functions.php or in a custom plugin.
3. Register a stored ID reference for post, media and term type.
4. Distribute the post and verify that the references update correctly on the target site.
5. Test with different scenarios, and ensure everything works as expected.

Changelog Entry

Added - New type parameter in distributor_register_data to enable utilization of the default pre/post callbacks for posts, terms, and media.

Credits

Props @dkotter @iamdharmesh

Checklist:

• I agree to follow this project's Code of Conduct.
• I have updated the documentation accordingly.
• I have added Critical Flows, Test Cases, and/or End-to-End Tests to cover my change.
• All new and existing tests pass.

[dkotter]

Haven't had time to actually test this but from a code perspective, this looks really good to me. Left a handful of minor comments

[iamdharmesh]

Finally, E2E tests are now passing in all env and we are ready to go with this.

[jeffpaul]

@iamdharmesh @peterwilsoncc would be great to sort out any updates needed from Peter's latest review so we can get this merged and ready for a v2.2 release

[peterwilsoncc]

This looks great, thank you.

My one thought is to make sure the post and term IDs differ between the two sites by adding the following to the end of initialize.sh

# Create some posts to bump the post IDs so they differ between the two sites.
wp-env run tests-cli wp post generate --count=10 --post_type=post --post_author=1
wp-env run tests-cli wp post generate --count=20 --post_type=post --post_author=1 --url=localhost/second

# Now delete the posts created by the test suite
wp-env run tests-cli wp post delete $(wp-env run tests-cli wp post list --post_type=post --format=ids) --force
wp-env run tests-cli wp post delete $(wp-env run tests-cli wp post list --post_type=post --format=ids --url=localhost/second) --url=localhost/second --force

# Create some terms to bump the term IDs so they differ between the two sites.
wp-env run tests-cli wp term generate category --count=10
wp-env run tests-cli wp term generate category --count=20 --url=localhost/second

# Now delete the terms created by the test suite
wp-env run tests-cli wp term delete category $(wp-env run tests-cli wp term list category --format=ids)
wp-env run tests-cli wp term delete category $(wp-env run tests-cli wp term list category --format=ids --url=localhost/second) --url=localhost/second

It's not a blocker so I'll approve now and you can decide.

[iamdharmesh]

My one thought is to make sure the post and term IDs differ between the two sites by adding the following to the end of initialize.sh

Thanks for suggestion @peterwilsoncc. This is added and PR is ready for merge.