Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Flush rewrite rules when language changed or translation updated #7435

Merged
merged 2 commits into from
Jan 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 4 additions & 0 deletions changelog/fix-404-after-language-switch
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
Significance: patch
Type: fixed

Flush rewrite rules when the website language was changed or the translation was updated.
34 changes: 34 additions & 0 deletions includes/class-sensei.php
Original file line number Diff line number Diff line change
Expand Up @@ -434,13 +434,47 @@
// Localisation
$this->load_plugin_textdomain();
add_action( 'init', array( $this, 'load_localisation' ), 0 );
add_action( 'update_option_WPLANG', array( $this, 'maybe_initiate_rewrite_rules_flush_after_language_change' ), 10, 2 );
add_action( 'upgrader_process_complete', array( $this, 'maybe_initiate_rewrite_rules_flush_on_translation_update' ), 10, 2 );

Check warning on line 438 in includes/class-sensei.php

View check run for this annotation

Codecov / codecov/patch

includes/class-sensei.php#L437-L438

Added lines #L437 - L438 were not covered by tests

$this->initialize_cache_groups();
$this->initialize_global_objects();
$this->initialize_cli();
$this->initialize_3rd_party_compatibility();
}

/**
* Maybe initiate rewrite rules flush when WordPress language has been changed.
*
* @internal
*
* @since $$next-version$$
*
* @param mixed $old_value Old value.
* @param mixed $new_value New value.
*/
public function maybe_initiate_rewrite_rules_flush_after_language_change( $old_value, $new_value ) {
if ( $old_value !== $new_value ) {
$this->initiate_rewrite_rules_flush();
}
}

/**
* Maybe initiate rewrite rules flush when WordPress translation has been updated.
*
* @internal
*
* @since $$next-version$$
*
* @param WP_Upgrader $upgrader_object Upgrader object.
* @param array $options Options.
*/
public function maybe_initiate_rewrite_rules_flush_on_translation_update( $upgrader_object, $options ) {
if ( 'translation' === $options['type'] ) {
$this->initiate_rewrite_rules_flush();
}
}

/**
* Global Sensei Instance
*
Expand Down
64 changes: 64 additions & 0 deletions tests/unit-tests/test-class-sensei.php
Original file line number Diff line number Diff line change
Expand Up @@ -210,6 +210,70 @@ public function testConstructor_Always_InitializesClockProperty() {
$this->assertInstanceOf( Clock_Interface::class, $sensei->clock );
}

public function testConstruct_Always_AddsActionOnUpdateOptionWplang() {
/* Arrange. */
$sensei = Sensei();

/* Assert. */
$this->assertSame( 10, has_action( 'update_option_WPLANG', [ $sensei, 'maybe_initiate_rewrite_rules_flush_after_language_change' ] ) );
}

public function testConstruct_Always_AddsActionOnUpgraderProcessComplete() {
/* Arrange. */
$sensei = Sensei();

/* Assert. */
$this->assertSame( 10, has_action( 'upgrader_process_complete', [ $sensei, 'maybe_initiate_rewrite_rules_flush_on_translation_update' ] ) );
}

public function testMaybeInitiateRewriteRulesFlushAfterLanguageChange_WhenLanguageChanged_UpdatesOption() {
/* Arrange. */
$sensei = Sensei();
update_option( 'sensei_flush_rewrite_rules', '0' );

/* Act. */
$sensei->maybe_initiate_rewrite_rules_flush_after_language_change( 'a', 'b' );

/* Assert. */
$this->assertSame( '1', get_option( 'sensei_flush_rewrite_rules' ) );
}

public function testMaybeInitiateRewriteRulesFlushAfterLanguageChange_WhenLanguageNotChanged_DoesntUpdateOption() {
/* Arrange. */
$sensei = Sensei();
update_option( 'sensei_flush_rewrite_rules', '0' );

/* Act. */
$sensei->maybe_initiate_rewrite_rules_flush_after_language_change( 'a', 'a' );

/* Assert. */
$this->assertSame( '0', get_option( 'sensei_flush_rewrite_rules' ) );
}

public function testMaybeInitiateRewriteRulesFlushOnTranslationUpdate_WhenNonTranslationUpdate_DoesntUpdateOption() {
/* Arrange. */
$sensei = Sensei();
update_option( 'sensei_flush_rewrite_rules', '0' );

/* Act. */
$sensei->maybe_initiate_rewrite_rules_flush_on_translation_update( new stdClass(), array( 'type' => 'a' ) );

/* Assert. */
$this->assertSame( '0', get_option( 'sensei_flush_rewrite_rules' ) );
}

public function testMaybeInitiateRewriteRulesFlushOnTranslationUpdate_WhenTranslationUpdate_UpdatesOption() {
/* Arrange. */
$sensei = Sensei();
update_option( 'sensei_flush_rewrite_rules', '0' );

/* Act. */
$sensei->maybe_initiate_rewrite_rules_flush_on_translation_update( new stdClass(), array( 'type' => 'translation' ) );

/* Assert. */
$this->assertSame( '1', get_option( 'sensei_flush_rewrite_rules' ) );
}

/**
* Create courses and comments for the course.
*
Expand Down