You are here

public function ConfigKeyProvider::deleteKeyValue in Key 8

Deletes the value of a key.

Parameters

\Drupal\key\KeyInterface $key: The key whose value will be deleted.

Return value

string TRUE if successful, FALSE if unsuccessful.

Overrides KeyProviderSettableValueInterface::deleteKeyValue

File

src/Plugin/KeyProvider/ConfigKeyProvider.php, line 102

Class

ConfigKeyProvider
Adds a key provider that allows a key to be stored in configuration.

Namespace

Drupal\key\Plugin\KeyProvider

Code

public function deleteKeyValue(KeyInterface $key) {

  // Nothing needs to be done, since the value will have been deleted
  // with the Key entity.
  return TRUE;
}