hook_theme() docs for path are inaccurate

This is my understanding from the issue summary, but I'm not sure if that's what it is really about. Any opinions/suggestions are welcome.

Hi I reviewed the patch and for me the new description managed to describe it correctly

I think #14 needs a reroll to 9.5.x, I've made this one, moving back to NR.

Oooops, my bad, here's a new one.

The new text sounds reasonable for me.

This change is not correct. If you don't supply the path in your hook_theme (this is the norm) it will default to the extension's templates directory. If you do supply a path then in needs to be relative to the root directory.

I think the wrong bit of the documentation has been changed. I think we could change the Ordinarily the module or theme path will be used as ordinarily the path will be set to the template directory in the module or theme's directory if

See...

        // Prepend the current theming path when none is set. This is required
        // for the default theme engine to know where the template lives.
        if (isset($result[$hook]['template']) && !isset($info['path'])) {
          $result[$hook]['path'] = $path . '/templates';
        }

in \Drupal\Core\Theme\Registry::processExtension

FWIW the isset($result[$hook]['template']) check is superfluous - it is guaranteed to be set because of prior code in the method.

Hi, i'll try to work on those changes specified in #20.

I tried to analyze better the theme api, but couldn't think in others change to the doc, so i only inset the text suggested in #20

I applied #23 patch against Drupal 9.5.x-dev and I can see that the text updated as suggested in #20.
Thanks @sophiavs

I'll be reviewing

The same as #24.

I applied the #23 patch and the hook_theme() docblock has the changes suggested in #20.

Patch failed because of unrelated issue, marking this issue as RTBC again

1. +++ b/core/lib/Drupal/Core/Render/theme.api.php
   @@ -1132,10 +1132,11 @@ function hook_page_bottom(array &$page_bottom) {
   + *     be set to the template directory in the module or theme's directory if
   

   It's the templates directory.

2. +++ b/core/lib/Drupal/Core/Render/theme.api.php
   @@ -1132,10 +1132,11 @@ function hook_page_bottom(array &$page_bottom) {
   + *     include it here. This path should be relative to the subdirectory
   + *     'templates' of the path of the extension implementing hook_theme().
   

   The original text of the last sentence is correct and should not be changed - it should be This path should be relative to the Drupal root directory.

@alexpott,
Made changes as per comment #29.
Needs review.

Here's what I think the text should be:

 *   - path: If specified, overrides the path to the directory that contains the
 *     file to be used. This path should be relative to the Drupal root
 *     directory. If not provided, the path will be set to the module or theme's
 *     templates directory.

I think this format is better because it begins with If specified, so you immediately know it does not have to be. And then it tells you want you should do if you do want to specify it. And finally it tells you the default behaviour if you don't specify it.

Changed the text as per your suggestion

I applied #33 patch against Drupal 9.5.x-dev and the hook_theme() docblock has the changes suggested in #31.
Thanks @ameymudras

#33 made the change per @alexpott recommendation in #31

Adding credits

This no longer applies to 10.1.x, can we get a re-roll.

We will likely need two patches, as it still applies to 9.5.x

Patch for Drupal version 10.1.x

Hi I rewiewed the last patch.

I was able to apply in drupal 10.1 version.
Issues changes keep there.
Core keep working as expected.

Moving to RTBC

The patch #39 contains lots of changes that are not supposed to be there. For example, it changes the root composer.json to install drush :)

ok sorry I will work on it

Hi I couldn't work on that

Thanks @alaxpott. It's my bad.
I have uploaded the updated patch.

ok now it's good.

I was able to apply in drupal 10.1 version.
Issues changes keep there. (no unrelated changes)
Core keep working as expected.
Moving to RTBC.

Committed f570135 and pushed to 10.1.x. Thanks!
Committed 85b728e and pushed to 10.0.x. Thanks!

Didn't apply to 9.5.x so I didn't backport there and I'm not sure it's worth it.

Found a 9.5.x version in #33 and committed that.

Committed 543019b and pushed to 9.5.x. Thanks!