Version 2.10.1

lloc · lloc · commit ab0f8a6a6680 · 2025-12-07T18:10:25.000+01:00
diff --git a/Changelog.md b/Changelog.md
@@ -1,3 +1,7 @@
+## 2.10.1
+* Fix: Deprecated function warning pointed to non-existent function.
+* Documentation: update README.md code snippets to reflect new function names.
+
 ## 2.10.0
 
 * Add prefixed public helper functions (msls_get_*, msls_the_msls) with deprecation shims for legacy names to satisfy WPCS while staying backward compatible.
diff --git a/MultisiteLanguageSwitcher.php b/MultisiteLanguageSwitcher.php
@@ -3,7 +3,7 @@
  * Multisite Language Switcher Plugin
  *
  * Plugin Name: Multisite Language Switcher
- * Version: 2.10.0
+ * Version: 2.10.1
  * Plugin URI: http://msls.co/
  * Description: A simple but powerful plugin that will help you to manage the relations of your contents in a multilingual multisite-installation.
  * Author: Dennis Ploetner
@@ -41,7 +41,7 @@
  * @author Dennis Ploetner <re@lloc.de>
  */
 if ( ! defined( 'MSLS_PLUGIN_VERSION' ) ) {
-	define( 'MSLS_PLUGIN_VERSION', '2.10.0' );
+	define( 'MSLS_PLUGIN_VERSION', '2.10.1' );
 	define( 'MSLS_PLUGIN_PATH', plugin_basename( __FILE__ ) );
 	define( 'MSLS_PLUGIN__FILE__', __FILE__ );
 
diff --git a/README.md b/README.md
@@ -53,8 +53,8 @@ If you plan to use the GitHub repository on a server, don't forget to run `compo
 *  Optional Theme Integration:
     *  Insert the following PHP code directly into your theme files to display language switcher links:
         ```php
-        if ( function_exists( 'the_msls' ) ) {
-            the_msls();
+        if ( function_exists( 'msls_the_switcher' ) ) {
+            msls_the_switcher();
         }
         ```
 Review the [Multisite Language Switcher Website](http://msls.co/) for more information. Some [diagrams](https://github.com/lloc/Multisite-Language-Switcher/blob/master/Diagrams.md) are also available. 
diff --git a/assets/css-flags/flags.php b/assets/css-flags/flags.php
@@ -32,10 +32,10 @@
 	'cy'             => 'flag-icon-gb-wls',
 	'da_DK'          => 'flag-icon-dk',
 	'de_AT'          => 'flag-icon-at',
-	'de_CH_informal' => 'flag-icon-ch',
 	'de_DE'          => 'flag-icon-de',
 	'de_DE_formal'   => 'flag-icon-de',
 	'de_CH'          => 'flag-icon-ch',
+	'de_CH_informal' => 'flag-icon-ch',
 	'dzo'            => 'flag-icon-bt',
 	'el'             => 'flag-icon-gr',
 	'en_NZ'          => 'flag-icon-nz',
@@ -97,8 +97,8 @@
 	'my_MM'          => 'flag-icon-mm',
 	'nb_NO'          => 'flag-icon-no',
 	'ne_NP'          => 'flag-icon-np',
-	'nl_NL'          => 'flag-icon-nl',
 	'nl_BE'          => 'flag-icon-be',
+	'nl_NL'          => 'flag-icon-nl',
 	'nl_NL_formal'   => 'flag-icon-nl',
 	'nn_NO'          => 'flag-icon-no',
 	'oci'            => 'flag-icon-es-ca',
diff --git a/assets/flags/flags.php b/assets/flags/flags.php
@@ -32,10 +32,10 @@
 	'cy'             => 'wales.png',
 	'da_DK'          => 'dk.png',
 	'de_AT'          => 'at.png',
-	'de_CH_informal' => 'ch.png',
 	'de_DE'          => 'de.png',
 	'de_DE_formal'   => 'de.png',
 	'de_CH'          => 'ch.png',
+	'de_CH_informal' => 'ch.png',
 	'dzo'            => 'bt.png',
 	'el'             => 'gr.png',
 	'en_NZ'          => 'nz.png',
@@ -97,8 +97,8 @@
 	'my_MM'          => 'mm.png',
 	'nb_NO'          => 'no.png',
 	'ne_NP'          => 'np.png',
-	'nl_NL'          => 'nl.png',
 	'nl_BE'          => 'be.png',
+	'nl_NL'          => 'nl.png',
 	'nl_NL_formal'   => 'nl.png',
 	'nn_NO'          => 'no.png',
 	'oci'            => 'catalonia.png',
diff --git a/build/translations.json b/build/translations.json
diff --git a/includes/MslsPlugin.php b/includes/MslsPlugin.php
@@ -206,9 +206,9 @@ public static function activate(): void {
 	 * The plugin data in all blogs of the current network will be
 	 * deleted after the uninstall procedure.
 	 *
-	 * @return boolean
+	 * @return void
 	 */
-	public static function uninstall() {
+	public static function uninstall(): void {
 		/**
 		 * We want to be sure that the user has not deactivated the
 		 * multisite because we need to use switch_to_blog and
@@ -225,7 +225,7 @@ public static function uninstall() {
 			}
 		}
 
-		return self::cleanup();
+		self::cleanup();
 	}
 
 	/**
diff --git a/includes/deprectated.php b/includes/deprectated.php
@@ -5,52 +5,52 @@
 /**
  * Deprecated: Get the output for using the links to the translations in your code.
  *
- * @deprecated 2.9.7 Use msls_get_the_msls()
+ * @deprecated 2.10.1 Use msls_get_switcher()
  *
  * @param mixed $attr
  *
  * @return string
  */
 // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound
 function get_the_msls( $attr ): string {
-	_deprecated_function( __FUNCTION__, '2.9.7', 'msls_get_the_msls' );
+	_deprecated_function( __FUNCTION__, '2.10.1', 'msls_get_switcher' );
 
 	return msls_get_switcher( $attr );
 }
 
 /**
  * Deprecated: Output the links to the translations in your template.
  *
- * @deprecated 2.9.7 Use msls_the_msls()
+ * @deprecated 2.10.1 Use msls_the_switcher()
  *
  * @param string[] $arr
  */
 // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound
 function the_msls( array $arr = array() ): void {
-	_deprecated_function( __FUNCTION__, '2.9.7', 'msls_the_msls' );
+	_deprecated_function( __FUNCTION__, '2.10.1', 'msls_the_switcher' );
 	msls_the_switcher( $arr );
 }
 
 /**
  * Deprecated: Gets the URL of the country flag-icon for a specific locale.
  *
- * @deprecated 2.9.7 Use msls_get_flag_url()
+ * @deprecated 2.10.1 Use msls_get_flag_url()
  *
  * @param string $locale
  *
  * @return string
  */
 // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound
 function get_msls_flag_url( string $locale ): string {
-	_deprecated_function( __FUNCTION__, '2.9.7', 'msls_get_flag_url' );
+	_deprecated_function( __FUNCTION__, '2.10.1', 'msls_get_flag_url' );
 
 	return msls_get_flag_url( $locale );
 }
 
 /**
  * Deprecated: Gets the description for a blog for a specific locale.
  *
- * @deprecated 2.9.7 Use msls_get_blog_description()
+ * @deprecated 2.10.1 Use msls_get_blog_description()
  *
  * @param string $locale
  * @param string $preset
@@ -59,15 +59,15 @@ function get_msls_flag_url( string $locale ): string {
  */
 // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound
 function get_msls_blog_description( string $locale, string $preset = '' ): string {
-	_deprecated_function( __FUNCTION__, '2.9.7', 'msls_get_blog_description' );
+	_deprecated_function( __FUNCTION__, '2.10.1', 'msls_get_blog_description' );
 
 	return msls_get_blog_description( $locale, $preset );
 }
 
 /**
  * Deprecated: Gets the permalink for a translation of the current post in a given language.
  *
- * @deprecated 2.9.7 Use msls_get_permalink()
+ * @deprecated 2.10.1 Use msls_get_permalink()
  *
  * @param string $locale
  * @param string $preset
@@ -76,7 +76,7 @@ function get_msls_blog_description( string $locale, string $preset = '' ): strin
  */
 // phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound
 function get_msls_permalink( string $locale, string $preset = '' ): string {
-	_deprecated_function( __FUNCTION__, '2.9.7', 'msls_get_permalink' );
+	_deprecated_function( __FUNCTION__, '2.10.1', 'msls_get_permalink' );
 
 	return msls_get_permalink( $locale, $preset );
 }
diff --git a/readme.txt b/readme.txt
@@ -6,7 +6,7 @@ Tags: multilingual, multisite, language, switcher, localization
 Requires at least: 6.1
 Tested up to: 6.9
 Requires PHP: 7.4
-Stable tag: 2.10.0
+Stable tag: 2.10.1
 License: GPLv2 or later
 License URI: http://www.gnu.org/licenses/gpl-2.0.html
 
diff --git a/src/msls-widget-block/block.json b/src/msls-widget-block/block.json
@@ -5,7 +5,7 @@
   "icon": "translation",
   "category": "widgets",
   "name": "lloc/msls-widget-block",
-  "version": "2.10.0",
+  "version": "2.10.1",
   "description": "Review the settings for the Multisite Language Switcher plugin, as the block utilizes the API function `the_msls()` for its output.",
   "example": {},
   "supports": {
diff --git a/tests/phpunit/TestDeprecated.php b/tests/phpunit/TestDeprecated.php
@@ -0,0 +1,53 @@
+<?php declare( strict_types=1 );
+
+namespace lloc\MslsTests;
+
+use Brain\Monkey\Functions;
+
+final class TestDeprecated extends MslsUnitTestCase {
+
+	public function test_get_the_msls(): void {
+		Functions\expect( '_deprecated_function' )->once();
+		Functions\expect( 'msls_get_switcher' )->once()->andReturn( '' );
+
+		get_the_msls( null );
+
+		$this->expectNotToPerformAssertions();
+	}
+
+	public function test_the_msls(): void {
+		Functions\expect( '_deprecated_function' )->once();
+		Functions\expect( 'msls_the_switcher' )->once()->andReturn( '' );
+
+		the_msls();
+
+		$this->expectNotToPerformAssertions();
+	}
+
+	public function test_get_msls_flag_url(): void {
+		Functions\expect( '_deprecated_function' )->once();
+		Functions\expect( 'msls_get_flag_url' )->once()->andReturn( '' );
+
+		get_msls_flag_url( 'en' );
+
+		$this->expectNotToPerformAssertions();
+	}
+
+	public function test_get_msls_blog_description(): void {
+		Functions\expect( '_deprecated_function' )->once();
+		Functions\expect( 'msls_get_blog_description' )->once()->andReturn( '' );
+
+		get_msls_blog_description( 'en' );
+
+		$this->expectNotToPerformAssertions();
+	}
+
+	public function test_get_msls_permalink(): void {
+		Functions\expect( '_deprecated_function' )->once();
+		Functions\expect( 'msls_get_permalink' )->once()->andReturn( '' );
+
+		get_msls_permalink( 'en' );
+
+		$this->expectNotToPerformAssertions();
+	}
+}
diff --git a/tests/phpunit/TestMslsPlugin.php b/tests/phpunit/TestMslsPlugin.php
@@ -61,6 +61,10 @@ function test_message_handler(): void {
 		MslsPlugin::message_handler( 'Test' );
 	}
 
+	public function test_direname(): void {
+		$expected = 'multisite-language-switcher/subpath';
+		$this->assertEquals( $expected, MslsPlugin::dirname( '/subpath' ) );
+	}
 	/**
 	 * Verify the static uninstall-method
 	 */
@@ -88,24 +92,30 @@ function test_uninstall(): void {
 
 		$test = new MslsPlugin( $options );
 
-		$this->assertIsBool( $test->uninstall() );
+		$test->uninstall();
+
+		$this->expectNotToPerformAssertions();
 	}
 
 	public function test_cleanup_false(): void {
-		Functions\when( 'delete_option' )->justReturn( false );
+		Functions\expect( 'delete_option' )->once()->andReturn( false );
+
+		MslsPlugin::cleanup();
 
-		$this->assertFalse( MslsPlugin::cleanup() );
+		$this->expectNotToPerformAssertions();
 	}
 
 	public function test_cleanup_true(): void {
-		Functions\when( 'delete_option' )->justReturn( true );
+		Functions\expect( 'delete_option' )->once()->andReturn( true );
 
 		global $wpdb;
 		$wpdb = \Mockery::mock( '\wpdb' );
 		$wpdb->shouldReceive( 'prepare' )->andReturn( '' );
 		$wpdb->shouldReceive( 'query' )->andReturn( true );
 
-		$this->assertTrue( MslsPlugin::cleanup() );
+		MslsPlugin::cleanup();
+
+		$this->expectNotToPerformAssertions();
 	}
 
 	public function test_plugin_dir_path(): void {
diff --git a/tests/phpunit/TestMslsRequest.php b/tests/phpunit/TestMslsRequest.php
@@ -21,6 +21,14 @@ public function test_has_var_ok(): void {
 		$this->assertTrue( MslsRequest::has_var( MslsFields::FIELD_MSLS_ID ) );
 	}
 
+	public function test_get_var_null(): void {
+		// INPUT_REQUEST (99) has been removed as of PHP 8.0.0; was not implemented previously.
+		$this->assertNull( MslsRequest::get_var( MslsFields::FIELD_MSLS_FILTER, 99 ) );
+
+		// INPUT_SESSION (6) has been removed as of PHP 8.0.0; was not implemented previously.
+		$this->assertNull( MslsRequest::get_var( MslsFields::FIELD_MSLS_FILTER, 6 ) );
+	}
+
 	public function test_get_var_ok(): void {
 		Functions\expect( 'filter_input' )->once()->with( INPUT_GET, MslsFields::FIELD_MSLS_FILTER, FILTER_SANITIZE_NUMBER_INT )->andReturn( 17 );
 
diff --git a/tests/phpunit/bootstrap.php b/tests/phpunit/bootstrap.php
@@ -2,3 +2,5 @@
 
 class_alias( \lloc\MslsTests\WP_Widget::class, '\WP_Widget' );
 class_alias( \lloc\MslsTests\WP_CLI::class, '\WP_CLI' );
+
+require_once __DIR__ . '/../../includes/deprectated.php';

Original file line number	Diff line number	Diff line change
`@@ -206,9 +206,9 @@ public static function activate(): void {`
`206`	`206`	`* The plugin data in all blogs of the current network will be`
`207`	`207`	`* deleted after the uninstall procedure.`
`208`	`208`	`*`
`209`		`- * @return boolean`
	`209`	`+ * @return void`
`210`	`210`	`*/`
`211`		`- public static function uninstall() {`
	`211`	`+ public static function uninstall(): void {`
`212`	`212`	`/**`
`213`	`213`	`* We want to be sure that the user has not deactivated the`
`214`	`214`	`* multisite because we need to use switch_to_blog and`
`@@ -225,7 +225,7 @@ public static function uninstall() {`
`225`	`225`	`}`
`226`	`226`	`}`
`227`	`227`
`228`		`- return self::cleanup();`
	`228`	`+ self::cleanup();`
`229`	`229`	`}`
`230`	`230`
`231`	`231`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -5,52 +5,52 @@`
`5`	`5`	`/**`
`6`	`6`	`* Deprecated: Get the output for using the links to the translations in your code.`
`7`	`7`	`*`
`8`		`- * @deprecated 2.9.7 Use msls_get_the_msls()`
	`8`	`+ * @deprecated 2.10.1 Use msls_get_switcher()`
`9`	`9`	`*`
`10`	`10`	`* @param mixed $attr`
`11`	`11`	`*`
`12`	`12`	`* @return string`
`13`	`13`	`*/`
`14`	`14`	`// phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound`
`15`	`15`	`function get_the_msls( $attr ): string {`
`16`		`- _deprecated_function( __FUNCTION__, '2.9.7', 'msls_get_the_msls' );`
	`16`	`+ _deprecated_function( __FUNCTION__, '2.10.1', 'msls_get_switcher' );`
`17`	`17`
`18`	`18`	`return msls_get_switcher( $attr );`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`/**`
`22`	`22`	`* Deprecated: Output the links to the translations in your template.`
`23`	`23`	`*`
`24`		`- * @deprecated 2.9.7 Use msls_the_msls()`
	`24`	`+ * @deprecated 2.10.1 Use msls_the_switcher()`
`25`	`25`	`*`
`26`	`26`	`* @param string[] $arr`
`27`	`27`	`*/`
`28`	`28`	`// phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound`
`29`	`29`	`function the_msls( array $arr = array() ): void {`
`30`		`- _deprecated_function( __FUNCTION__, '2.9.7', 'msls_the_msls' );`
	`30`	`+ _deprecated_function( __FUNCTION__, '2.10.1', 'msls_the_switcher' );`
`31`	`31`	`msls_the_switcher( $arr );`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`/**`
`35`	`35`	`* Deprecated: Gets the URL of the country flag-icon for a specific locale.`
`36`	`36`	`*`
`37`		`- * @deprecated 2.9.7 Use msls_get_flag_url()`
	`37`	`+ * @deprecated 2.10.1 Use msls_get_flag_url()`
`38`	`38`	`*`
`39`	`39`	`* @param string $locale`
`40`	`40`	`*`
`41`	`41`	`* @return string`
`42`	`42`	`*/`
`43`	`43`	`// phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound`
`44`	`44`	`function get_msls_flag_url( string $locale ): string {`
`45`		`- _deprecated_function( __FUNCTION__, '2.9.7', 'msls_get_flag_url' );`
	`45`	`+ _deprecated_function( __FUNCTION__, '2.10.1', 'msls_get_flag_url' );`
`46`	`46`
`47`	`47`	`return msls_get_flag_url( $locale );`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`/**`
`51`	`51`	`* Deprecated: Gets the description for a blog for a specific locale.`
`52`	`52`	`*`
`53`		`- * @deprecated 2.9.7 Use msls_get_blog_description()`
	`53`	`+ * @deprecated 2.10.1 Use msls_get_blog_description()`
`54`	`54`	`*`
`55`	`55`	`* @param string $locale`
`56`	`56`	`* @param string $preset`
`@@ -59,15 +59,15 @@ function get_msls_flag_url( string $locale ): string {`
`59`	`59`	`*/`
`60`	`60`	`// phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound`
`61`	`61`	`function get_msls_blog_description( string $locale, string $preset = '' ): string {`
`62`		`- _deprecated_function( __FUNCTION__, '2.9.7', 'msls_get_blog_description' );`
	`62`	`+ _deprecated_function( __FUNCTION__, '2.10.1', 'msls_get_blog_description' );`
`63`	`63`
`64`	`64`	`return msls_get_blog_description( $locale, $preset );`
`65`	`65`	`}`
`66`	`66`
`67`	`67`	`/**`
`68`	`68`	`* Deprecated: Gets the permalink for a translation of the current post in a given language.`
`69`	`69`	`*`
`70`		`- * @deprecated 2.9.7 Use msls_get_permalink()`
	`70`	`+ * @deprecated 2.10.1 Use msls_get_permalink()`
`71`	`71`	`*`
`72`	`72`	`* @param string $locale`
`73`	`73`	`* @param string $preset`
`@@ -76,7 +76,7 @@ function get_msls_blog_description( string $locale, string $preset = '' ): strin`
`76`	`76`	`*/`
`77`	`77`	`// phpcs:ignore WordPress.NamingConventions.PrefixAllGlobals.NonPrefixedFunctionFound`
`78`	`78`	`function get_msls_permalink( string $locale, string $preset = '' ): string {`
`79`		`- _deprecated_function( __FUNCTION__, '2.9.7', 'msls_get_permalink' );`
	`79`	`+ _deprecated_function( __FUNCTION__, '2.10.1', 'msls_get_permalink' );`
`80`	`80`
`81`	`81`	`return msls_get_permalink( $locale, $preset );`
`82`	`82`	`}`