Feature request: Publicly accessible method to reindex a given post ID

[graham73may]

Is your feature request related to a problem? Please describe.
I am trying to hook in to re-index WPML translations of the post I'm saving. Happy to do this myself but I'm just hitting protect/private methods all over the place and final classes that I can't extend.

Describe the solution you'd like
I'd like to use Algolia_Posts_Index::get_records() to prepare my data.

Then my plan is to run it through Algolia_Index::sanitize_json_data() and $index->saveObjects().

Describe alternatives you've considered
I've tried extending the Algolia_Posts_Index but it is marked as final. Alternatively could final be removed?

Is there a way I can re-index a specific given post_id?

I've been looking at this thread specifically but it triggers pages and pages of reindexing, I just want the given post_id, not a full re-index.
#10 (comment)

Any advice would be much appreciated.

Thanks

[tw2113]

Hi @graham73may

Understood if you're not sure or don't know, but are translations run through the standard WordPress hooks when saving posts? Most specifically any/all from https://github.com/WebDevStudios/wp-search-with-algolia/blob/2.10.1/includes/watchers/class-algolia-post-changes-watcher.php#L108-L131

Asking because the plugin is presently wired up to watch/sync individual posts as they get edited. Update a popular post to add in some new content, hit save, and the Algolia indexed copy should get updated as well.

I also recall/know we have #454 opened around this topic too, opened by yourself :)

I know I have a branch started, but with minimal at best changes so far. I'm wondering/curious if that Algolia_CLI could be extended with a variation of specific posts indexing added in until we get something formally worked up for this. That said, if you wanted to do a PR we'd happily work with you to get something contributed to the core plugin too.

[graham73may]

Hi @tw2113

WPML stores each translation as a separate post in the database, separate ID, meta etc. I've checked and none of the related posts are triggered when saving one of the languages.

The issue I'm trying to resolve is if English is in Algolia and I create a French version, the English version isn't aware a French version exists so doesn't show any "also available in French" in the listing results. So my plan is to just re-sync all the languages each time any one of them is saved.

Ha yes... I've been tinkering with that also, but haven't managed to get it working just yet. I was having a similar problem hitting private methods and final classes. It didn't provide much opportunity to extend things.

I had to pivot away from Algolia_Posts_Index and I've ended up cherry picking the parts I need from Algolia_plugin::load_indices()

I've ended up with this which does what I need it to do, I only need to focus on posts and I only have one search index so I'm able to be fairly restrictive. It took quite a while to reach this point, would be interested if you know of a more obvious solution 😬 .

/**
 * Reindex other languages in Algolia when a post is saved.
 *
 * @param int $post_id The ID of the post being saved.
 *
 * @return void
 */
function algolia_reindex_other_languages_on_save( $post_id ) {
	// Autosave.
	if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) {
		return;
	}

	// AJAX.
	if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
		return;
	}

	// Post revision.
	if ( false !== wp_is_post_revision( $post_id ) ) {
		return;
	}

	// Get any available translations (custom function).
	$translations = get_content_translations( $post_id );

	if ( ! empty( $translations ) ) {
		// Get the post IDs.
		$translation_ids = array_column( $translations, 'element_id' );

		// Remove the current post ID.
		$translation_ids = array_diff( $translation_ids, array( $post_id ) );

		if ( ! empty( $translation_ids ) ) {
			// Get the parts of the Algolia plugin we need for indexing.
			$plugin            = Algolia_Plugin_Factory::create();
			$client            = $plugin->get_api()->get_client();
			$index_name_prefix = $plugin->get_settings()->get_index_name_prefix();

			// Add a searchable posts index.
			$searchable_post_types = get_post_types(
				array(
					'exclude_from_search' => false,
				),
				'names'
			);
			$searchable_post_types = (array) apply_filters( 'algolia_searchable_post_types', $searchable_post_types );
			$index                 = new Algolia_Searchable_Posts_Index( $searchable_post_types );
			$index->set_name_prefix( $index_name_prefix );
			$index->set_client( $client );
			$index->set_enabled( true );

			// The Post changes watcher is the only one that we'll need on save_post.
			$watcher = new Algolia_Post_Changes_Watcher( $index );

			// Loop through the post IDs of the other languages.
			foreach ( $translation_ids as $translation_id ) {
				// Sync the post ID.
				$watcher->sync_item( $translation_id );
			}
		}
	}
}

add_action( 'save_post', 'algolia_reindex_other_languages_on_save' );

Here's the other helper function that I already had for working with WPML for reference:

/**
 * @param string $post_id
 *
 * @return array|bool|mixed
 */
function get_content_translations( $post_id = '' ) {
	global $sitepress;

	if ( empty( $post_id ) ) {
		$post_id = get_the_ID();
	}

	$wpml_post_type = 'post_' . get_post_type( $post_id );

	$t_post_id               = $sitepress->get_element_trid( $post_id, $wpml_post_type );
	$translations            = $sitepress->get_element_translations( $t_post_id, $wpml_post_type, false, true );
	$translations_that_exist = array();

	foreach ( $translations as $key => $translation ) {
		if ( ! empty( $translation->post_status ) && $translation->post_status === 'publish' ) {
			$translations_that_exist[ $key ] = $translation;
		}
	}

	if ( ! empty( $translations_that_exist ) ) {
		return $translations_that_exist;
	}

	return array();
}

[graham73may]

/**
 * Reindexes a specific post in Algolia.
 *
 * @param int $post_id The ID of the post to reindex.
 *
 * @return void
 */
function sbx_algolia_reindex_post( $post_id ) {
	// Get the parts of the Algolia plugin we need for indexing.
	$plugin            = Algolia_Plugin_Factory::create();
	$client            = $plugin->get_api()->get_client();
	$index_name_prefix = $plugin->get_settings()->get_index_name_prefix();

	// Add a searchable posts index.
	$searchable_post_types = get_post_types(
		array(
			'exclude_from_search' => false,
		),
		'names'
	);
	$searchable_post_types = (array) apply_filters( 'algolia_searchable_post_types', $searchable_post_types );
	$index                 = new Algolia_Searchable_Posts_Index( $searchable_post_types );
	$index->set_name_prefix( $index_name_prefix );
	$index->set_client( $client );
	$index->set_enabled( true );

	// The Post changes watcher is the only one that we'll need on save_post.
	$watcher = new Algolia_Post_Changes_Watcher( $index );

	// Sync the post ID.
	$watcher->sync_item( $post_id );
}

Made a function I can throw in wherever I need, which has fixed the bug I was having with my custom CLI command.

wp client_name reindex_post_type group
Reindexing 380 posts.
Success: Post ID 276447 re-indexed. (group: Spanish Title)
Success: Post ID 275694 re-indexed. (group: English Title)
Success: Post ID 276448 re-indexed. (group: French Title)
Success: Post ID 273353 re-indexed. (group: French Title)
...

(Sharing incase its helpful for anyone stumbling on this)

[tw2113]

Curious if you somehow have something going on with WPML, or maybe I have a version that's older and handles things differently.

I just activated and did a translation of a post, and the translated version showed up in my Algolia index without me having to do any extra work outside of click save within WPML

My original post is the "Chasing Amy" item, and the translated version is shown at the top of the image.

This isn't to say you're not encountering challenges overall, just that something is definitely up with the install at the moment. The question is what.

[graham73may]

The (rather niche) scenario I have is that I need the English item to be re-indexed when I create a translation.

I don't have any issues with translations being indexed, if I make a French post, the French post is indexed. This is all working fine.

The issue stems from my frontend which looks like this:

What currently happens is my English item in Algolia is unaware that French or Spanish have been created, so the "Also in..." text doesn't appear until I go into English, make no edits and hit Update in the WP backend.

What I'm trying to do here is, on French save, reindex the English. Which in turn updates the "Also In..." metadata.

[tw2113]

Noted and hmmm.