How to redirect after a VBO run and use an array constructed in executeMultiple

Hi, just made it possible with the above commit.

You do it like this from you action plugin:

  /**
   * {@inheritdoc}
   */
  public function setContext(array &$context) {
    $this->context['sandbox'] = &$context['sandbox'];
    $this->context['results'] = &$context['results'];
    foreach ($context as $key => $item) {
      if ($key === 'sandbox' || $key === 'results') {
        continue;
      }
      $this->context[$key] = $item;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function execute($entity = NULL) {
    // Execute..
    // When you know this is the last operation:
    $this->context['results']['redirect_url'] = \Drupal\Core\Url::fromRoute('system.admin');

of course add a the Drupal\Core\Url namespace and conform to standards etc ;)

also this works only if batching is enabled so would be good to have that for non-batch operations as well but that needs a change in a few places. For later if someone will need this.

I could use a non-batched version.

I don't really want to do much processing in the action apart from assembling a set of URL parameters based on the selected entities, then redirect to a custom controller route that will do most of my processing. I guess I can set my batch size high, but non-batched would be good.

Actually it's likely we will need to batch the processing somewhere anyway, so we might as well do our processing in the action and stash the result in private tempstore for the redirect page controller to pick up. Thanks, this is working well.

I'm extending ViewsBulkOperationsActionBase.

Note user.private_tempstore is deprecated - you should use tempstore.private, which is fully backwards-compatible.

@DuneBL the same reason why we have interfaces and method and property visibility declarations. If we don't have to give access to something - we don't. At least that's the way I see it, this makes everything more controllable and reduces possible vulnerabilities. I guess some older dev could explain it better ;)

My use case might be a bit different, but here is how I solved a redirect from VBO, that does something with the selected entities:

My custom action plugin:

namespace Drupal\my_module\Plugin\Action;

use Drupal\views_bulk_operations\Action\ViewsBulkOperationsActionBase;

/**
 * Redirects to a delivery note creation form.
 *
 * @Action(
 *   id = "delivery_note_create",
 *   label = @Translation("Create delivery note"),
 *   type = "package",
 *   confirm_form_route_name = "entity.delivery_note.add_form",
 *   pass_view = TRUE
 * )
 */
class CreateDeliveryNote extends ViewsBulkOperationsActionBase {

  /**
   * {@inheritdoc}
   */
  public function executeMultiple(array $entities) {
    // This action doesn't actually do anything.
    // The selected entity IDs get passed to
    // \Drupal\my_module\Form\DeliveryNoteAddForm instead.
  }

  ...
}

Key element here is the "confirm_form_route_name" property in the annotation, which is the route where we want to redirect to, after having selected entities via VBO.

Then I have a custom form, which in my case is a content entity form where I want to pre-select the entities that were selected via VBO:

namespace Drupal\my_module\Form;

use Drupal\Component\Datetime\TimeInterface;
use Drupal\Core\Entity\ContentEntityForm;
use Drupal\Core\Entity\EntityManagerInterface;
use Drupal\Core\Entity\EntityTypeBundleInfoInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\TempStore\PrivateTempStoreFactory;
use Drupal\Core\Url;
use Drupal\views_bulk_operations\Form\ViewsBulkOperationsFormTrait;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Form controller for Delivery note add forms.
 */
class DeliveryNoteAddForm extends ContentEntityForm {

  use ViewsBulkOperationsFormTrait;

  /**
   * The tempstore factory.
   *
   * @var \Drupal\Core\TempStore\PrivateTempStoreFactory
   */
  protected $tempStoreFactory;

  /**
   * Constructs a ContentEntityForm object.
   *
   * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
   *   The entity manager.
   * @param \Drupal\Core\Entity\EntityTypeBundleInfoInterface $entity_type_bundle_info
   *   The entity type bundle service.
   * @param \Drupal\Component\Datetime\TimeInterface $time
   *   The time service.
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
   *   The tempstore factory.
   */
  public function __construct(EntityManagerInterface $entity_manager, EntityTypeBundleInfoInterface $entity_type_bundle_info = NULL, TimeInterface $time = NULL, PrivateTempStoreFactory $temp_store_factory, AccountInterface $current_user) {
    parent::__construct($entity_manager, $entity_type_bundle_info, $time);
    $this->tempStoreFactory = $temp_store_factory;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static(
      $container->get('entity.manager'),
      $container->get('entity_type.bundle.info'),
      $container->get('datetime.time'),
      $container->get('tempstore.private')
    );
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $view_data = $this->getTempstoreData('[VIEW_NAME]', '[DISPLAY_ID]');

    // Get all entities selected through VBO.
    $selected_ids = [];
    if ($view_data['list']) {
      foreach ($view_data['list'] as $selected_data) {
        [, $langcode, $entity_type_id, $id] = $selected_data;
        selected_ids[] = $id;
      }
    }

    (... custom logic here to do something with the selected entity IDs)

    $form = parent::buildForm($form, $form_state);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function save(array $form, FormStateInterface $form_state) {
    parent::save($form, $form_state);

    // Delete VBO temp storage.
    $this->deleteTempstoreData('[VIEW_NAME]', '[DISPLAY_ID]');
    $form_state->setRedirect('entity.delivery_note.canonical', ['delivery_note' => $entity->id()]);
  }

}

[VIEW_NAME] & [DISPLAY_ID] are the View machine name, and the Views display ID / name, where the VBO checkboxes where added.

Switching to fixed, please feel free to reopen if some additional improvements can be made to the API.

Please check #3207304: Allow to override the batch finished method. for a new API, when this is merged we'll be able to override the entire batch finished callback with redirection in any action class.