Come together with the global Drupal community in Rotterdam, 28 Sept – 1 Oct 2026. Sessions, contribution, connection, and Early Bird savings until 8 June.Problem/Motivation
Views Add Handler is not very informative when Help is missing, yet views.api.php does not make it clear that relationships can contain help.
Steps to reproduce
- Follow the documentation in views.api.php to add a relationship between custom external database tables that all have a structure like
- Person table with id
- Multiple tables with relationship set as person_id
- Quickly get lost as to which relationship to add to create the desired joins
Proposed resolution
Update the documentation to show that help can be used
Remaining tasks
Provide MR
User interface changes
None
API changes
None
Data model changes
None
Release notes snippet
Updated views.api.php to show that help text can be provided for relationships
| Comment | File | Size | Author |
|---|---|---|---|
| #5 | 3422845-nr-bot.txt | 657 bytes | needs-review-queue-bot |
| #3 | with-helptext.png | 28.44 KB | scott_euser |
| #3 | no-helptext.png | 21.11 KB | scott_euser |
Issue fork drupal-3422845
Show commands
Start within a Git clone of the project using the version control instructions.
Or, if you do not have SSH keys set up on git.drupalcode.org:
changes
Comments
Comment #3
scott_euser commentedMinor thing, but would have saved me some time, so hoping this tiny addition saves someone else some time in the future. Thanks!
Before adding 'help' key to relationship:
After adding 'help' key to relationship:
Comment #4
smustgrave commentedSeems like a straight forward improvement and makes sense to me (I think)
Comment #5
needs-review-queue-bot commentedThe Needs Review Queue Bot tested this issue. It fails the Drupal core commit checks. Therefore, this issue status is now "Needs work".
This does not mean that the patch necessarily needs to be re-rolled or the MR rebased. Read the Issue Summary, the issue tags and the latest discussion here to determine what needs to be done.
Consult the Drupal Contributor Guide to find step-by-step guides for working with issues.
Comment #6
scott_euser commentedHmmm that's odd, no phpstan failures. Not sure what needs review bot is complaining about - will revert it back to RTBC. Thanks!
Comment #7
nod_phpstan and .api.php files have issues in non-CI runs
Comment #8
nod_Need to change the term so that we don't use dummy.
Comment #9
scott_euser commentedApologies was trying to keep it in line with the existing code which called the field 'dummy' already + commented about that in that way, but given your steer have updated that + line 501 + the related comment (which you did not ask for, hope that's okay - if not I can create a follow-up).
Comment #10
nod_Perfect just need a rtbc now :)
Comment #11
scott_euser commentedThanks! Maybe @smustgrave if you have time you could consider the latest tweaks and RTBC again?
Comment #12
smustgrave commentedHappily!
Comment #13
nod_got some issues with the pre-commit hooks (same issue the NR-bot runs into) so I'll be committing that when i figure out the workaround.
Comment #14
scott_euser commentedSounds good, thank you both! Hope it's not too painful!
Comment #16
nod_Committed 5c30729 and pushed to 11.x. Thanks!