interface MenuLinkFormInterface

Same name in other branches
  1. 9 core/lib/Drupal/Core/Menu/Form/MenuLinkFormInterface.php \Drupal\Core\Menu\Form\MenuLinkFormInterface
  2. 10 core/lib/Drupal/Core/Menu/Form/MenuLinkFormInterface.php \Drupal\Core\Menu\Form\MenuLinkFormInterface
  3. 11.x core/lib/Drupal/Core/Menu/Form/MenuLinkFormInterface.php \Drupal\Core\Menu\Form\MenuLinkFormInterface

Defines an interface for edit forms of menu links.

All menu link plugins use the same interface for their configuration or editing form, but the implementations may differ.

Hierarchy

Expanded class hierarchy of MenuLinkFormInterface

All classes that implement MenuLinkFormInterface

See also

\Drupal\Core\Menu\MenuLinkInterface::getFormClass()

File

core/lib/Drupal/Core/Menu/Form/MenuLinkFormInterface.php, line 17

Namespace

Drupal\Core\Menu\Form
View source
interface MenuLinkFormInterface extends PluginFormInterface {
    
    /**
     * Injects the menu link plugin instance.
     *
     * @param \Drupal\Core\Menu\MenuLinkInterface $menu_link
     *   A menu link plugin instance.
     */
    public function setMenuLinkInstance(MenuLinkInterface $menu_link);
    
    /**
     * Extracts a plugin definition from form values.
     *
     * @param array $form
     *   An associative array containing the structure of the form.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     *
     * @return array
     *   The new plugin definition values taken from the form values. The plugin
     *   ID must be returned as part of the definition.
     */
    public function extractFormValues(array &$form, FormStateInterface $form_state);

}

Members

Title Sort descending Modifiers Object type Summary Overrides
MenuLinkFormInterface::extractFormValues public function Extracts a plugin definition from form values. 1
MenuLinkFormInterface::setMenuLinkInstance public function Injects the menu link plugin instance. 1
PluginFormInterface::buildConfigurationForm public function Form constructor. 32
PluginFormInterface::submitConfigurationForm public function Form submission handler. 31
PluginFormInterface::validateConfigurationForm public function Form validation handler. 17

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