Deprecate activitypub_post_locale in favor of activitypub_locale (#1370)

* Deprecate activitypub_post_locale in favor of activitypub_locale

Follow-up to #1367

* check for WP_Post

---------

Co-authored-by: Matthias Pfefferle <[email protected]>

Author: jeherve

CHANGELOG.md

@@ -29,6 +29,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * Outbox processing accounts for shared inboxes again.
 * Improved check for `?activitypub` query-var.
 * Rewrite rules: be more specific in author rewrite rules to avoid conflicts on sites that use the "@author" pattern in their permalinks.
+* Deprecate the `activitypub_post_locale` filter in favor of the `activitypub_locale` filter.
 
 ### Fixed
 

includes/transformer/class-base.php

@@ -236,6 +236,28 @@ public function to_activity( $type ) {
 	protected function get_locale() {
 		$lang = \strtolower( \strtok( \get_locale(), '_-' ) );
 
+		if ( $this->item instanceof \WP_Post ) {
+			/**
+			 * Deprecates the `activitypub_post_locale` filter.
+			 *
+			 * @param string $lang The locale of the post.
+			 * @param mixed  $item The post object.
+			 *
+			 * @return string The filtered locale of the post.
+			 */
+			$lang = apply_filters_deprecated(
+				'activitypub_post_locale',
+				array(
+					$lang,
+					$this->item->ID,
+					$this->item,
+				),
+				'5.4.0',
+				'activitypub_locale',
+				'Use the `activitypub_locale` filter instead.'
+			);
+		}
+
 		/**
 		 * Filter the locale of the post.
 		 *

includes/transformer/class-post.php

@@ -77,33 +77,6 @@ public function get_content_visibility() {
 		return $this->content_visibility;
 	}
 
-	/**
-	 * Get the post's locale.
-	 * By default, the post's locale is the same as the blog's locale,
-	 * and is already set in the parent class's get_locale() method.
-	 * This method allows for overriding the locale for a specific post,
-	 * via a `activitypub_post_locale` filter.
-	 *
-	 * @return string The post's locale.
-	 */
-	public function get_locale() {
-		/**
-		 * Filter the locale of the post.
-		 *
-		 * @param string  $lang    The locale of the post.
-		 * @param int     $post_id The post ID.
-		 * @param WP_Post $post    The post object.
-		 *
-		 * @return string The filtered locale of the post.
-		 */
-		return apply_filters(
-			'activitypub_post_locale',
-			parent::get_locale(),
-			$this->item->ID,
-			$this->item
-		);
-	}
-
 	/**
 	 * Returns the User-Object of the Author of the Post.
 	 *

integration/class-wpml.php

@@ -17,19 +17,23 @@ class WPML {
 	 * Initialize the class, registering WordPress hooks.
 	 */
 	public static function init() {
-		\add_filter( 'activitypub_post_locale', array( self::class, 'get_wpml_post_locale' ), 10, 2 );
+		\add_filter( 'activitypub_locale', array( self::class, 'get_wpml_post_locale' ), 10, 2 );
 	}
 
 	/**
 	 * Fetch the post locale from the WPML post data.
 	 *
-	 * @param string $lang    The language code.
-	 * @param int    $post_id The post ID.
+	 * @param string $lang The language code.
+	 * @param int    $post The post object.
 	 *
 	 * @return string The modified language code.
 	 */
-	public static function get_wpml_post_locale( $lang, $post_id ) {
-		$language_details = apply_filters( 'wpml_post_language_details', null, $post_id );
+	public static function get_wpml_post_locale( $lang, $post ) {
+		if ( ! $post instanceof \WP_Post ) {
+			return $lang;
+		}
+
+		$language_details = apply_filters( 'wpml_post_language_details', null, $post->ID );
 
 		if ( is_array( $language_details ) && isset( $language_details['language_code'] ) ) {
 			$lang = $language_details['language_code'];

readme.txt

@@ -148,6 +148,7 @@ For reasons of data protection, it is not possible to see the followers of other
 * Changed: Outbox processing accounts for shared inboxes again.
 * Changed: Improved check for `?activitypub` query-var.
 * Changed: Rewrite rules: be more specific in author rewrite rules to avoid conflicts on sites that use the "@author" pattern in their permalinks.
+* Changed: Deprecate the `activitypub_post_locale` filter in favor of the `activitypub_locale` filter.
 * Fixed: The Outbox purging routine no longer is limited to deleting 5 items at a time.
 * Fixed: An issue where the outbox could not send object types other than `Base_Object` (introduced in 5.0.0).
 * Fixed: Ellipses now display correctly in notification emails for Likes and Reposts.