Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.Problem/Motivation
Currently all of the following preprocess functions are contained in a themeable group:
- template_preprocess_time()
- template_preprocess_datetime_form()
- template_preprocess_datetime_wrapper()
- template_preprocess_status_messages()
- template_preprocess_links()
- template_preprocess_image()
- template_preprocess_table()
- template_preprocess_tablesort_indicator()
- template_preprocess_item_list()
- template_preprocess_feed_icon()
- template_preprocess_container()
- template_preprocess_maintenance_task_list()
Preprocess functions shouldn't be in the themeable documentation group. Preprocess functions that are mistakenly added as part of the themeable group show up in https://api.drupal.org/api/drupal/core%21modules%21system%21theme.api.ph... which we don't want.
Documentation standards references:
https://www.drupal.org/node/1354#themeable
https://www.drupal.org/node/1354#templates
https://www.drupal.org/node/1354#themepreprocess
Proposed resolution
Remove the @addtogroup that is currently wrapping all of the above preprocess functions as well as theme_indentation(), and just add an @ingroup themeable line to theme_indentation() instead.
Remaining tasks
- Create patch
- Review patch
Beta phase evaluation
| Issue category | Bug because it doesn't mesh with our existing coding standards for preprocess functions |
|---|---|
| Issue priority | Normal |
| Unfrozen changes | Unfrozen because it only changes documentation |
| Prioritized changes | This is not a prioritized change for the beta phase. |
| Disruption | No disruption for core or contrib. |
User interface changes
n/a
API changes
n/a
| Comment | File | Size | Author |
|---|---|---|---|
| #2 | 2452371-2.patch | 993 bytes | Palashvijay4O |
Comments
Comment #1
star-szrMoving things around a bit.
Comment #2
Palashvijay4O CreditAttribution: Palashvijay4O commentedAttached a patch.
Comment #3
Palashvijay4O CreditAttribution: Palashvijay4O commentedOops!! Changing the status now....
Comment #4
star-szrLooks perfect, thanks @Palashvijay4O!
Comment #5
star-szrAdding missing word to issue summary.
Comment #6
jhodgdonThanks!
Comment #7
alexpottDoucmentation is not frozen in beta. Committed 0c70a3a and pushed to 8.0.x. Thanks!
Comment #9
star-szrAfter the API page got updated, I noticed some more housekeeping that can be done: #2457271: More cleanup of the 'themeable' documentation group