Admin theme not active when using batch export method and a display path starting with admin/

Thanks Eric!

Looks good to me - approach is sensible, and fixes our unexpected behaviour with front theme on admin path.

Thanks for the patch. It fixes the problem.

+1 to get this committed

Actually the "batch" path should always use the admin theme regardless of views path starts with "/admin" or not, because this is also the case in the core:

system.batch_page.json:
  path: '/batch'
  defaults:
    _controller: '\Drupal\system\Controller\BatchController::batchPage'
  requirements:
    _access: 'TRUE'
    _format: 'json'
  options:
    _admin_route: TRUE

So here the batch uses always the admin theme and this should be the case with the patch for this issue. I removed the

str_starts_with($this->getOption('path') ?? '', 'admin/')

part from the patch.

@ericgsmith

Indeed, you are right. Thanks! I hid my patch.

this patch works for me.

@ericgsmith, my patch will just automatically use the admin theme when it's using the batch. it is not logically correct since some use cases should allow batch to appear within a theme, i will hide my patch..

I've tested patch #17 on Drupal 10.2.6 with Views Data Export 8.x-1.4 and it works really nice, thanks @erom.

After module update to 1.5 patch #7 can't be applied anymore. Adding re-rolled patch while MR is in review

#23 works as expected for us on 1.5.0

Patch #23 works well with no issues.

Looking at this now, we already provide the route and change some options on it, so we don't need to alter our own route I don't think.

@ericgsmith thanks so much for the issue, code and the tests, super helpful.

I've basically committed what you had, but in our method that generates the original route, rather than altering the collection of them. Seems to work fine, and your tests still pass :)

Thanks everyone!

If anyone got to this issue and wondered why your views data export display is still showing in the front end theme instead of the admin theme, it is most likely because your view path does not start with "/admin". This is because the change for this issue only targeted those paths - see https://git.drupalcode.org/project/views_data_export/-/commit/fcafcfeac3....

This can be fixed in your build by implementing a route subscriber. See https://www.drupal.org/docs/drupal-apis/routing-system/altering-existing... for details on how to create one.

Example: The following will set all "data_export" views displays to use the admin theme.

namespace Drupal\your_custom_module\Routing;

use Drupal\Core\Routing\RouteSubscriberBase;
use Symfony\Component\Routing\RouteCollection;

/**
 * Listens to the dynamic route events.
 */
class RouteSubscriber extends RouteSubscriberBase {

  /**
   * {@inheritdoc}
   */
  protected function alterRoutes(RouteCollection $collection) {
    foreach ($collection->all() as $name => $route) {
      // Set all views_data_export diplays to use the admin theme.
      if (str_starts_with($name, 'view.') &&
          ($display_plugin_id = $route->getOption('_view_display_plugin_id')) &&
          $display_plugin_id === 'data_export') {
        $route->setOption('_admin_route', TRUE);
      }
    }
  }

}