Add option to hide followers and following lists (#2294)

Author: pfefferle

.github/changelog/2294-from-description

@@ -0,0 +1,4 @@
+Significance: minor
+Type: added
+
+Added a privacy option to hide followers and following lists from profiles while keeping follow relationships intact.

includes/class-activitypub.php

@@ -234,6 +234,18 @@ public static function register_user_meta() {
 			)
 		);
 
+		\register_meta(
+			'user',
+			$blog_prefix . 'activitypub_hide_social_graph',
+			array(
+				'type'              => 'integer',
+				'description'       => 'Hide Followers and Followings on Profile.',
+				'single'            => true,
+				'default'           => 0,
+				'sanitize_callback' => 'absint',
+			)
+		);
+
 		\register_meta(
 			'user',
 			$blog_prefix . 'activitypub_old_host_data',

includes/collection/class-actors.php

@@ -817,4 +817,19 @@ public static function normalize_identifier( $actor ) {
 		_deprecated_function( __METHOD__, '7.4.0', 'Remote_Actors::normalize_identifier' );
 		return Remote_Actors::normalize_identifier( $actor );
 	}
+
+	/**
+	 * Determine if social graph (followers and following) should be shown for a given user.
+	 *
+	 * @param int $user_id The user ID.
+	 *
+	 * @return bool True if social graph should be shown, false otherwise.
+	 */
+	public static function show_social_graph( $user_id ) {
+		if ( self::BLOG_USER_ID === (int) $user_id ) {
+			return ! (bool) \get_option( 'activitypub_hide_social_graph' );
+		} else {
+			return ! (bool) \get_user_option( 'activitypub_hide_social_graph', $user_id );
+		}
+	}
 }

includes/rest/class-followers-controller.php

@@ -7,6 +7,7 @@
 
 namespace Activitypub\Rest;
 
+use Activitypub\Collection\Actors;
 use Activitypub\Collection\Followers;
 use Activitypub\Collection\Remote_Actors;
 
@@ -98,12 +99,15 @@ public function get_items( $request ) {
 		$data = Followers::get_followers_with_count( $user_id, $per_page, $page, array( 'order' => \ucwords( $order ) ) );
 
 		$response = array(
-			'@context'     => get_context(),
-			'id'           => get_rest_url_by_path( \sprintf( 'actors/%d/followers', $user_id ) ),
-			'generator'    => 'https://wordpress.org/?v=' . get_masked_wp_version(),
-			'type'         => 'OrderedCollection',
-			'totalItems'   => $data['total'],
-			'orderedItems' => \array_filter(
+			'@context'   => get_context(),
+			'id'         => get_rest_url_by_path( \sprintf( 'actors/%d/followers', $user_id ) ),
+			'generator'  => 'https://wordpress.org/?v=' . get_masked_wp_version(),
+			'type'       => 'OrderedCollection',
+			'totalItems' => $data['total'],
+		);
+
+		if ( Actors::show_social_graph( $user_id ) ) {
+			$response['orderedItems'] = \array_filter(
 				\array_map(
 					function ( $item ) use ( $context ) {
 						if ( 'full' === $context ) {
@@ -117,8 +121,8 @@ function ( $item ) use ( $context ) {
 					},
 					$data['followers']
 				)
-			),
-		);
+			);
+		}
 
 		$response = $this->prepare_collection_response( $response, $request );
 		if ( \is_wp_error( $response ) ) {

includes/rest/class-following-controller.php

@@ -104,12 +104,15 @@ public function get_items( $request ) {
 		$data = Following::get_following_with_count( $user_id, $per_page, $page, array( 'order' => \ucwords( $order ) ) );
 
 		$response = array(
-			'@context'     => get_context(),
-			'id'           => get_rest_url_by_path( \sprintf( 'actors/%d/following', $user_id ) ),
-			'generator'    => 'https://wordpress.org/?v=' . get_masked_wp_version(),
-			'type'         => 'OrderedCollection',
-			'totalItems'   => $data['total'],
-			'orderedItems' => \array_filter(
+			'@context'   => get_context(),
+			'id'         => get_rest_url_by_path( \sprintf( 'actors/%d/following', $user_id ) ),
+			'generator'  => 'https://wordpress.org/?v=' . get_masked_wp_version(),
+			'type'       => 'OrderedCollection',
+			'totalItems' => $data['total'],
+		);
+
+		if ( Actors::show_social_graph( $user_id ) ) {
+			$response['orderedItems'] = \array_filter(
 				\array_map(
 					function ( $item ) use ( $context ) {
 						if ( 'full' === $context ) {
@@ -123,8 +126,8 @@ function ( $item ) use ( $context ) {
 					},
 					$data['following']
 				)
-			),
-		);
+			);
+		}
 
 		/**
 		 * Filter the list of following urls

includes/wp-admin/class-admin.php

@@ -245,6 +245,7 @@ public static function save_user_settings( $user_id ) {
 
 		// User options that have a default value and therefore can't be empty (Empty triggers the default value).
 		$required_user_options = array(
+			'activitypub_hide_social_graph',
 			'activitypub_mailer_new_dm',
 			'activitypub_mailer_new_follower',
 			'activitypub_mailer_new_mention',

includes/wp-admin/class-blog-settings-fields.php

@@ -19,7 +19,7 @@ class Blog_Settings_Fields {
 	 * Initialize the settings fields.
 	 */
 	public static function init() {
-		add_action( 'load-settings_page_activitypub', array( self::class, 'register_settings' ) );
+		\add_action( 'load-settings_page_activitypub', array( self::class, 'register_settings' ) );
 	}
 
 	/**
@@ -31,41 +31,41 @@ public static function register_settings() {
 			\update_option( 'activitypub_checklist_profile_setup_visited', '1' );
 		}
 
-		add_settings_section(
+		\add_settings_section(
 			'activitypub_blog_profile',
-			__( 'Blog Profile', 'activitypub' ),
+			\__( 'Blog Profile', 'activitypub' ),
 			'__return_empty_string',
 			'activitypub_blog_settings'
 		);
 
-		add_settings_field(
+		\add_settings_field(
 			'activitypub_blog_avatar',
-			__( 'Manage Avatar', 'activitypub' ),
+			\__( 'Manage Avatar', 'activitypub' ),
 			array( self::class, 'avatar_callback' ),
 			'activitypub_blog_settings',
 			'activitypub_blog_profile'
 		);
 
-		add_settings_field(
+		\add_settings_field(
 			'activitypub_header_image',
-			__( 'Manage Header Image', 'activitypub' ),
+			\__( 'Manage Header Image', 'activitypub' ),
 			array( self::class, 'header_image_callback' ),
 			'activitypub_blog_settings',
 			'activitypub_blog_profile'
 		);
 
-		add_settings_field(
+		\add_settings_field(
 			'activitypub_blog_identifier',
-			__( 'Change Profile ID', 'activitypub' ),
+			\__( 'Change Profile ID', 'activitypub' ),
 			array( self::class, 'profile_id_callback' ),
 			'activitypub_blog_settings',
 			'activitypub_blog_profile',
 			array( 'label_for' => 'activitypub_blog_identifier' )
 		);
 
-		add_settings_field(
+		\add_settings_field(
 			'activitypub_blog_description',
-			__( 'Change Description', 'activitypub' ),
+			\__( 'Change Description', 'activitypub' ),
 			array( self::class, 'description_callback' ),
 			'activitypub_blog_settings',
 			'activitypub_blog_profile',
@@ -80,38 +80,46 @@ public static function register_settings() {
 			'activitypub_blog_profile'
 		);
 
-		add_settings_field(
+		\add_settings_field(
 			'activitypub_extra_fields',
-			__( 'Extra Fields', 'activitypub' ),
+			\__( 'Extra Fields', 'activitypub' ),
 			array( self::class, 'extra_fields_callback' ),
 			'activitypub_blog_settings',
 			'activitypub_blog_profile'
 		);
 
-		add_settings_field(
+		\add_settings_field(
 			'activitypub_blog_user_also_known_as',
-			__( 'Account Aliases', 'activitypub' ),
+			\__( 'Account Aliases', 'activitypub' ),
 			array( self::class, 'also_known_as_callback' ),
 			'activitypub_blog_settings',
 			'activitypub_blog_profile'
 		);
+
+		\add_settings_field(
+			'activitypub_hide_social_graph',
+			\__( 'Followers and Followings', 'activitypub' ),
+			array( self::class, 'hide_followers_callback' ),
+			'activitypub_blog_settings',
+			'activitypub_blog_profile'
+		);
 	}
 
 	/**
 	 * Avatar field callback.
 	 */
 	public static function avatar_callback() {
 		?>
-		<?php if ( has_site_icon() ) : ?>
-			<p><img src="<?php echo esc_url( get_site_icon_url( 50 ) ); ?>" alt="" /></p>
+		<?php if ( \has_site_icon() ) : ?>
+			<p><img src="<?php echo \esc_url( \get_site_icon_url( 50 ) ); ?>" alt="" /></p>
 		<?php endif; ?>
 		<p class="description">
 			<?php
-			echo wp_kses(
+			echo \wp_kses(
 				sprintf(
 					// translators: %s is a URL.
-					__( 'The ActivityPub plugin uses the WordPress Site Icon as Avatar for the Blog-Profile, you can change the Site Icon in the "<a href="%s">General Settings</a>" of WordPress.', 'activitypub' ),
-					esc_url( admin_url( 'options-general.php' ) )
+					\__( 'The ActivityPub plugin uses the WordPress Site Icon as Avatar for the Blog-Profile, you can change the Site Icon in the "<a href="%s">General Settings</a>" of WordPress.', 'activitypub' ),
+					\esc_url( \admin_url( 'options-general.php' ) )
 				),
 				'default'
 			);
@@ -295,11 +303,26 @@ class="large-text"
 			><?php echo esc_textarea( implode( PHP_EOL, (array) $also_known_as ) ); ?></textarea>
 		</label>
 		<p class="description">
-			<?php esc_html_e( 'If you’re moving from another account to this one, you’ll need to create an alias here first before transferring your followers. This step is safe, reversible, and doesn’t affect anything on its own. The migration itself is initiated from your old account.', 'activitypub' ); ?>
+			<?php esc_html_e( 'If you&#8217;re moving from another account to this one, you&#8217;ll need to create an alias here first before transferring your followers. This step is safe, reversible, and doesn’t affect anything on its own. The migration itself is initiated from your old account.', 'activitypub' ); ?>
 		</p>
 		<p class="description">
 		<?php echo \wp_kses_post( \__( 'Enter one account per line. Profile links or usernames like <code>@[email protected]</code> are accepted and will be automatically normalized to the correct format.', 'activitypub' ) ); ?>
 		</p>
 		<?php
 	}
+
+	/**
+	 * Hide Social Graph field callback.
+	 */
+	public static function hide_followers_callback() {
+		?>
+		<label>
+			<input type="checkbox" name="activitypub_hide_social_graph" id="activitypub_hide_social_graph" value="1" <?php \checked( '1', \get_option( 'activitypub_hide_social_graph', '0' ) ); ?> />
+			<?php \esc_html_e( 'Hide Followers and Following on Profile', 'activitypub' ); ?>
+		</label>
+		<p class="description">
+			<?php esc_html_e( 'People you follow will still see that you follow them.', 'activitypub' ); ?>
+		</p>
+		<?php
+	}
 }

includes/wp-admin/class-settings.php

@@ -336,6 +336,17 @@ public static function register_settings() {
 			)
 		);
 
+		\register_setting(
+			'activitypub_blog',
+			'activitypub_hide_social_graph',
+			array(
+				'type'              => 'integer',
+				'description'       => 'Hide Followers and Followings on Profile.',
+				'default'           => 0,
+				'sanitize_callback' => 'absint',
+			)
+		);
+
 		// Moderation settings.
 		\register_setting(
 			'activitypub',

includes/wp-admin/class-user-settings-fields.php

@@ -19,7 +19,7 @@ class User_Settings_Fields {
 	 * Initialize the settings fields.
 	 */
 	public static function init() {
-		add_action( 'load-profile.php', array( self::class, 'register_settings' ) );
+		\add_action( 'load-profile.php', array( self::class, 'register_settings' ) );
 	}
 
 	/**
@@ -91,6 +91,14 @@ public static function register_settings() {
 			array( 'label_for' => 'activitypub_also_known_as' )
 		);
 
+		\add_settings_field(
+			'activitypub_hide_social_graph',
+			\__( 'Followers and Followings', 'activitypub' ),
+			array( self::class, 'hide_followers_callback' ),
+			'activitypub_user_settings',
+			'activitypub_user_profile'
+		);
+
 		// Add moderation section.
 		\add_settings_section(
 			'activitypub_user_moderation',
@@ -380,4 +388,20 @@ public static function blocked_keywords_callback() {
 		</div>
 		<?php
 	}
+
+	/**
+	 * Hide Social Graph field callback.
+	 */
+	public static function hide_followers_callback() {
+		$hide_followers = \get_user_option( 'activitypub_hide_social_graph', \get_current_user_id() );
+		?>
+		<label>
+			<input type="checkbox" name="activitypub_hide_social_graph" id="activitypub_hide_social_graph" value="1" <?php \checked( '1', $hide_followers ); ?> />
+			<?php \esc_html_e( 'Hide Followers and Following on Profile', 'activitypub' ); ?>
+		</label>
+		<p class="description">
+			<?php esc_html_e( 'People you follow will still see that you follow them.', 'activitypub' ); ?>
+		</p>
+		<?php
+	}
 }