In our custom module, mymodule we have a form MyModuleForm where we want to allow for an image to be uploaded or chosen from already uploaded images. Below is the MyModuleForm.php file, but cannot figure out why we are not able to upload the Image and save it. There is a menu link where the module's form is and when we navigate to the page we see a blank page with no field or widget to set the image.


  1. To be able to make the Image Browser widget display so that we can use an existing image or upload one.
  2. Store the image using MyModuleForm from the custom module.
  3. We should be able to change the image as needed and save the configuration.
  4. Set file status to permanent.
  5. Add to file usage calculation.

How do we add an Image field on our MyModuleForm so that we can either use an existing image or upload a new one?

Here is what we tried but didn't work


class MyModuleForm extends ConfigFormBase {
  protected function getEditableConfigNames() {
    return [

  public function getFormId() {
    return 'mymodule_form';

  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this->config('mymodule.settings');
    $form['my_file'] = [
      '#type' => 'managed_file',
      '#title' => 'my file',
      '#name' => 'my_custom_file',
      '#description' => $this->t('my file description'),
      '#default_value' => $config->get('my_file'),
      '#upload_location' => 'public://'

    return parent::buildForm($form, $form_state);

  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);

  public function submitForm(array &$form, FormStateInterface $form_state) {
    // Check if image is uploaded.
    if(isset($form_state['default_press_release_image'])) {
      // Set file status to permanent.
      $image = $form_state->getValue('my_file');
      $file = File::load($image[0]);
      // Add to file usage calculation.

      ->set('default_press_release_image', $form_state->getValue('default_press_release_image'))

    parent::submitForm($form, $form_state);
  • 1
    This sounds like a route problem, what does your route configuration looks like? Please update the question accordingly – Stefanos Petrakis Nov 20 '18 at 21:58

Your Answer

By clicking “Post Your Answer”, you agree to our terms of service, privacy policy and cookie policy

Browse other questions tagged or ask your own question.