Add Media images to sitemap

Thanks for your patch! Would you mind uploading one for 8.x-3.x? New features go only into 3.x. I'll be happy to review and commit once the patch applies.

re-roll

re-roll

Hi,

What is the problem we are trying to resolve with this patch?

@angela_G Thanks for your patches!

As far as I understand the screenshots, for media images there is no need to choose an images style, but for core image fields a style can be chosen?

• Why does it allow to choose multiple styles?
• Would it make more sense to unclutter the UI by including all media fields and not let the user choose which media fields to include? For regular sitemaps you usually want all images displayed on the website to be included.
• Also we should discuss if not to remove support for regular image fields altogether.

re-roll

re-roll

The images_styles are added as an array in the config and its not been handled in the code. Because of which we get `Warning: Illegal offset type in Drupal\simple_sitemap\Form\FormHelper->displayEntitySettings() (line 416 of modules/contrib/simple_sitemap/src/Form/FormHelper.php)` Adding the patch for the same

Thanks @rajeshwari10, would you mind adding an interdiff?

I just tested this patch locally and I love what it's doing. Though I did find an issue where if the page doesn't have an image connected then the sitemap entry for the page disappears.

Steps to reproduce:
- Make a page with an image type and sitemap turned on with images by default
- Create a piece of content without an image
- Rebuild sitemap

You'll notice that this particular page/entity is missing from the sitemap.

Can't reproduce. see

    // Add images if any.
    if (!empty($url_data['images'])) {
      foreach ($url_data['images'] as $image) {
        $this->writer->startElement('image:image');
        $this->writer->writeElement('image:loc', $image['path']);
        if (strlen($image['title']) > 0) {
          $this->writer->writeElement('image:title', $image['title']);
        }
        if (strlen($image['alt']) > 0) {
          $this->writer->writeElement('image:caption', $image['alt']);
        }
        $this->writer->endElement();
      }
    }
  }

From my pov your problem is not affected by this patch.

I patched the code with #20 and found an issue where when selected no Image style you would get an error when trying to build the image url.

The error is at line 285 of EntityUrlGeneratorBase.php. Instead of if (!empty($entity_settings['image_styles'])) { you could use if (!empty(array_filter($entity_settings['image_styles']))) { as the $entity_settings['image_styles'] equals ['' => ''] when no style is selected.

I can reproduce the findings of catapiper #23.
I used the patch of #20
sitemap 8.x-3.5
drupal 8.8.2
If one has slected the media field and the image style only for some content types all of the others are missing in the generated sitemap. If I don‘t select an image style it produces the issue #23 describes (I haven‘t tested his solution by now...

re-roll

Fix #23- please test

For your consideration. I added a check for the existence of an `'image_styles'` key on the `$entity_settings` array.

array_key_exists('image_styles', $entity_settings) && 

Rerolled patch #29 as it failed to apply, please review.

clean re-roll

added isset check (isset and is_array is sufficent in this case)

wrong interdiff.xt in #32

add correct interdiff.txt

Fix Warning: Illegal offset type in Drupal\simple_sitemap\Form\FormHelper->displayEntitySettings()

re-roll

Error:
The custom default base url was not implementing for image files.

Fixed this and updated patch #34 for version 3.7.0

The custom default base url was not implementing for image files. Fixed this and updated patch #35 for version 3.8.0

Add validation for checking if media exists or not to avoid error if media doesn't exist.

Are there any settings to make it work ? I can't see the new fields in the sitemap settings of my node types after applying patch #40.

re-roll

re-roll

Still no change for me (tested with 8.x-3.10).

Do i understand this correctly. The module currently does not support adding images from a node that are added by entity reference. Like here: https://developers.google.com/search/docs/advanced/sitemaps/image-sitemaps

This patch has the goal to make that possible?

I applied the patch to the latest 3.1 and i get images added to the xml. Like this:

<image:image>
   <image:loc>http://dev9.abc.de/sites/funkkopfhoerer-infos.de/files/test-galeriebilder/sony_mdr_ds6500_8128.jpg</image:loc>
  </image:image>
  <image:image>
   <image:loc>http://dev9.abc.de/sites/funkkopfhoerer-infos.de/files/test-galeriebilder/sony_mdr_ds6500_8130.jpg</image:loc>
  </image:image>

Looks good.

Warning: If you use this patch the contrub sitemap index module will not work no more, fix info is there
#3230211: Errors when creating

Would it make sense to hide the image row using the styles on the page the user views? Like adding this to the main css

  table ul.images{
  display: none;
}

I also think adding title/alt makes a lot of sense so we have descriptive images and not just images. It seems code add that but nothing is output even alt/title is present.

Code is inside "getEntityImageUrls"
Where media fields are looped using "fforeach ($entity->get($media_field)->getValue() as $value) {"
Later there is the alt and title set using $value['alt'] and $value['title']. These are always empty because $value only contians the target_id

If you add
$value['alt'] = $media->get($field->getName())->getValue()[0]['alt'];
$value['title'] = $media->get($field->getName())->getValue()[0]['title'];

above the existing $fid beeing loaded it will work.
$fid = $media->get($field->getName())->getValue()[0]['target_id'];

Just a quick look i took this night. What do you think?

3.x is feature complete now, let's focus on 4.x.

re-roll

typo

- Latest patch with version 4.0 applies cleanly (did not apply to latest version released a few days ago)
- have enabled image to be included in sitemap in basic page with default image style
- have created a node and added media image
- rebuild queue and generate sitemap from admin/config/search/simplesitemap but sitemap does not include any images

what am I missing ?

re-roll

@GiorgosK: It only works for entities. In sitemap configuration enable node entity and set entity type settings.

Patch in 52 results in PHP notices due to undefined index 'settings'. Updated patch attached.

Patch #21 from #3152961: Image support for Paragraphs & Media also adds support for images from media entities.

A few thoughts about the current issue.

First of all we need to add general support. Settings for choosing fields and image styles can be taken out in a separate discussion. So far this seems to me like an unnecessary complication of the user interface. It might be better to move this feature to a hook level.

Tested #53 applied the patch sucessfully to the latest 4.1 and latest 4.x-dev

re-roll #53

I am running 4.1-dev - on php 8.1.7 and Drupal 9.4.3. My sitemap.xml file has no media in it, although the patch create the expansion for paragraphs and media very nicely. I am using Paragraphs with w3css theme - images are handled via w3css Images library manager. All my images are stored this way.

All my media is Webp and managed under media library - while the images are available directly with file call, the w3css-mediawrapper call isn't being handled correctly. I guess the obvious question first, should I see these images in the sitemap? The second question, would duplicating the images into the basic media library as simple images - currently they are 'W3css-image' isn't being index I don't think. Am I doing this wrongly or are my expectations set incorrect?

Hi, I'm using the patch for media field on nodes and it looks fine. Thank you.

Hi, patch #60 is no longer applicable on version 4.1.6.

Hi, I've updated the patch and I've also added a quick fix when $fid variable is null.

fix test failures

Thank you @slasher for the updated patch! I've tested and it works fine on my use case.

re-roll

Thank you everyone for contributing.

First of all we need to add general support. Settings for choosing fields and image styles can be taken out in a separate discussion. So far this seems to me like an unnecessary complication of the user interface. It might be better to move this feature to a hook level.

I agree and I just commited #3152961: Image support for Paragraphs & Media. I appreciate that patches from this here issue allow for more configuration, but the current/linked solution basically extends the old generic functionality to work with paragraphs & media and does not exceed this module's scope (unlike the solution provided here).

Please test the dev version and get back to me in the other issue.