[1.x] feat: add setting to disable sticky pinning on All Discussions page

extensions/sticky/extend.php

@@ -49,6 +49,9 @@
 
     new Extend\Locales(__DIR__.'/locale'),
 
+    (new Extend\Settings())
+        ->default('flarum-sticky.pin_sticky_on_all_discussions', true),
+
     (new Extend\Event())
         ->listen(Saving::class, SaveStickyToDatabase::class)
         ->listen(DiscussionWasStickied::class, [Listener\CreatePostWhenDiscussionIsStickied::class, 'whenDiscussionWasStickied'])

extensions/sticky/js/src/admin/index.js

@@ -1,13 +1,21 @@
 import app from 'flarum/admin/app';
 
 app.initializers.add('flarum-sticky', () => {
-  app.extensionData.for('flarum-sticky').registerPermission(
-    {
-      icon: 'fas fa-thumbtack',
-      label: app.translator.trans('flarum-sticky.admin.permissions.sticky_discussions_label'),
-      permission: 'discussion.sticky',
-    },
-    'moderate',
-    95
-  );
+  app.extensionData
+    .for('flarum-sticky')
+    .registerSetting({
+      setting: 'flarum-sticky.pin_sticky_on_all_discussions',
+      label: app.translator.trans('flarum-sticky.admin.settings.pin_sticky_on_all_discussions_label'),
+      help: app.translator.trans('flarum-sticky.admin.settings.pin_sticky_on_all_discussions_help'),
+      type: 'boolean',
+    })
+    .registerPermission(
+      {
+        icon: 'fas fa-thumbtack',
+        label: app.translator.trans('flarum-sticky.admin.permissions.sticky_discussions_label'),
+        permission: 'discussion.sticky',
+      },
+      'moderate',
+      95
+    );
 });

extensions/sticky/locale/en.yml

@@ -11,6 +11,11 @@ flarum-sticky:
     permissions:
       sticky_discussions_label: Sticky discussions
 
+    # These translations are used in the Settings page of the admin interface.
+    settings:
+      pin_sticky_on_all_discussions_label: Pin stickied discussions on the All Discussions page
+      pin_sticky_on_all_discussions_help: When enabled (default), unread stickied discussions are pinned to the top of the All Discussions page. When disabled, stickied discussions appear at their natural position by latest activity. Tag pages always pin stickied discussions to the top regardless of this setting.
+
   # Translations in this namespace are used by the forum user interface.
   forum:
 

extensions/sticky/src/PinStickiedDiscussionsToTop.php

@@ -11,10 +11,21 @@
 
 use Flarum\Filter\FilterState;
 use Flarum\Query\QueryCriteria;
+use Flarum\Settings\SettingsRepositoryInterface;
 use Flarum\Tags\Query\TagFilterGambit;
 
 class PinStickiedDiscussionsToTop
 {
+    /**
+     * @var SettingsRepositoryInterface
+     */
+    protected $settings;
+
+    public function __construct(SettingsRepositoryInterface $settings)
+    {
+        $this->settings = $settings;
+    }
+
     public function __invoke(FilterState $filterState, QueryCriteria $criteria)
     {
         if ($criteria->sortIsDefault) {
@@ -36,6 +47,13 @@ public function __invoke(FilterState $filterState, QueryCriteria $criteria)
                 return;
             }
 
+            // On "all discussions", admins can disable sticky pinning entirely.
+            // When disabled, stickied discussions appear at their natural
+            // last_posted_at position rather than being floated to the top.
+            if (! $this->settings->get('flarum-sticky.pin_sticky_on_all_discussions', true)) {
+                return;
+            }
+
             // Otherwise, if we are viewing "all discussions", only pin stickied
             // discussions to the top if they are unread. To do this in a
             // performant way we create another query which will select all

extensions/sticky/tests/integration/api/ListDiscussionsTest.php

@@ -117,4 +117,60 @@ public function list_discussions_shows_stick_first_on_a_tag()
 
         $this->assertEquals([3, 1, 2, 4], Arr::pluck($data['data'], 'id'));
     }
+
+    /** @test */
+    public function list_discussions_does_not_pin_sticky_on_all_when_setting_disabled_as_guest()
+    {
+        $this->setting('flarum-sticky.pin_sticky_on_all_discussions', '0');
+
+        $response = $this->send(
+            $this->request('GET', '/api/discussions')
+        );
+
+        $this->assertEquals(200, $response->getStatusCode());
+
+        $data = json_decode($response->getBody()->getContents(), true);
+
+        $this->assertEquals([2, 4, 3, 1], Arr::pluck($data['data'], 'id'));
+    }
+
+    /** @test */
+    public function list_discussions_does_not_pin_unread_sticky_on_all_when_setting_disabled_as_user()
+    {
+        $this->setting('flarum-sticky.pin_sticky_on_all_discussions', '0');
+
+        $response = $this->send(
+            $this->request('GET', '/api/discussions', [
+                'authenticatedAs' => 2
+            ])
+        );
+
+        $this->assertEquals(200, $response->getStatusCode());
+
+        $data = json_decode($response->getBody()->getContents(), true);
+
+        $this->assertEquals([2, 4, 3, 1], Arr::pluck($data['data'], 'id'));
+    }
+
+    /** @test */
+    public function list_discussions_pins_sticky_on_a_tag_when_setting_disabled()
+    {
+        $this->setting('flarum-sticky.pin_sticky_on_all_discussions', '0');
+
+        $response = $this->send(
+            $this->request('GET', '/api/discussions', [
+                'authenticatedAs' => 3
+            ])->withQueryParams([
+                'filter' => [
+                    'tag' => 'general'
+                ]
+            ])
+        );
+
+        $this->assertEquals(200, $response->getStatusCode());
+
+        $data = json_decode($response->getBody()->getContents(), true);
+
+        $this->assertEquals([3, 1, 2, 4], Arr::pluck($data['data'], 'id'));
+    }
 }