I create a custom form module. Now I want show my form in a block. How can I do this ?

Note: I create MymoduleBlock.php in /modules/my-module/src/Plugin/Block path with this code but not work:


namespace Drupal\my-module\Plugin\Block;

use Drupal\Core\Form\FormInterface;
use Drupal\Core\Block\BlockBase;

class MymoduleBlock extends BlockBase {
  public function build() {
    $form = \Drupal::formBuilder()->getForm('Drupal\my-module\Form\MymoduleForm');
    return $form;
  • 2
    If that is indeed all your code then you are missing the annotation. Check the docblock of other blocks. the @Block part is required
    – Berdir
    Jul 28, 2017 at 21:43

2 Answers 2


The code in MymoduleBlock::build() is correct, and it is what Drupal core does in UserLoginBlock::build().

  $form = \Drupal::formBuilder()->getForm('Drupal\user\Form\UserLoginForm');
  // When unsetting field descriptions, also unset aria-describedby attributes
  // to avoid introducing an accessibility bug.
  // @todo Do this automatically in https://www.drupal.org/node/2547063.
  $form['name']['#size'] = 15;
  $form['pass']['#size'] = 15;

What the block definition is missing is the annotation (the comment before the class) which allows Drupal to identify that class as plugin. See what Block API says. (Emphasis is mine.)

Blocks are a combination of a configuration entity and a plugin. The configuration entity stores placement information (theme, region, weight) and any other configuration that is specific to the block. The block plugin does the work of rendering the block's content for display.

Block plugins use the annotations defined by \Drupal\Core\Block\Annotation\Block. See the Annotations topic for more information about annotations.

In the block class I used as example, the annotation is the following one.

 * @Block(
 *   id = "user_login_block",
 *   admin_label = @Translation("User login"),
 *   category = @Translation("Forms")
 * )

Also, the machine name of module should not contain hyphens, which aren't allowed in PHP functions. That creates problems when you implement hooks, since the hook name is derived from the machine name of the module. For example, the implementation of hook_page_attachments() for your module would be my-module_page_attachments(), which is not an acceptable PHP function name.
If you think your module is not going to implement hooks, keep in mind that the majority of modules implements at least hook_update_N(), for which is also preferable not using capital letters in the module machine name.


Provided that you are posting all your code you are missing annotations in your Block class. Annotations are used by Drupal 8 to register plugins.

Check out this link to get started on custom blocks:


Don't forget to clear your cache after creating your block plugin.

P.S. I see that you named your module 'my-module'. Dashes are not allowed in module names, use underscores. For more information about module naming please see: https://www.drupal.org/docs/8/creating-custom-modules/naming-and-placing-your-drupal-8-module

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service and acknowledge that you have read and understand our privacy policy and code of conduct.