function WorkflowTypeInterface::deleteState

Same name and namespace in other branches
  1. 9 core/modules/workflows/src/WorkflowTypeInterface.php \Drupal\workflows\WorkflowTypeInterface::deleteState()
  2. 8.9.x core/modules/workflows/src/WorkflowTypeInterface.php \Drupal\workflows\WorkflowTypeInterface::deleteState()
  3. 10 core/modules/workflows/src/WorkflowTypeInterface.php \Drupal\workflows\WorkflowTypeInterface::deleteState()

Deletes a state from the workflow.

Parameters

string $state_id: The state ID to delete.

Return value

$this The workflow type plugin.

Throws

\InvalidArgumentException Thrown if $state_id does not exist.

1 method overrides WorkflowTypeInterface::deleteState()
WorkflowTypeBase::deleteState in core/modules/workflows/src/Plugin/WorkflowTypeBase.php
Deletes a state from the workflow.

File

core/modules/workflows/src/WorkflowTypeInterface.php, line 185

Class

WorkflowTypeInterface
An interface for Workflow type plugins.

Namespace

Drupal\workflows

Code

public function deleteState($state_id);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.