interface DisplayBuilderInterface in Panels 8.4

Defines the DisplayBuilder plugin type.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\panels\Plugin\DisplayBuilder\DisplayBuilderInterface

1 file declares its use of DisplayBuilderInterface

PanelsDisplayVariant.php in src/Plugin/DisplayVariant/PanelsDisplayVariant.php

File

src/Plugin/DisplayBuilder/DisplayBuilderInterface.php, line 11

Namespace

Drupal\panels\Plugin\DisplayBuilder

interface DisplayBuilderInterface extends PluginInspectionInterface {

  /**
   * Renders a Panels display.
   *
   * This is the outermost method in the Panels render pipeline. It calls the
   * inner methods, which return a content array, which is in turn passed to the
   * theme function specified in the layout plugin.
   *
   * @param Drupal\panels\Plugin\DisplayVariant\PanelsDisplayVariant
   *   The Panels display variant to render.
   *
   * @return array
   *   Render array modified by the display builder.
   */
  public function build(PanelsDisplayVariant $panels_display);

}

Members

Name	Modifiers	Type	Description	Overrides
DisplayBuilderInterface::build	public	function	Renders a Panels display.	1
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2