Twenty Nineteen: Improve code organisation in template-functions.php

[allancole]

Originally reported by @grapplerulrich in the Twenty Nineteen GitHub repo:

The header in the template-functions.php file is described as:

Functions which enhance the theme by hooking into WordPress

According to that description, all of the functions within template-functions.php should hook into either a filter or an action of WordPress.

This is not the case for the following functions:

• twentynineteen_can_show_post_thumbnail()
• twentynineteen_image_filters_enabled()
• twentynineteen_post_thumbnail_sizes_attr()
• twentynineteen_get_avatar_size()
• twentynineteen_is_comment_by_post_author()
• twentynineteen_get_discussion_data()
• twentynineteen_hsl_hex()

These are helper functions that would fit best in another file like inc/helper-functions.php.

Also, twentynineteen_add_dropdown_icons() could be moved to icon-functions.php to join twentynineteen_nav_menu_social_icons().

Original ticket here: ​https://github.com/WordPress/twentynineteen/issues/548

[akshayar]

I have moved the common functions in inc/helper-functions.php.

Also, twentynineteen_add_dropdown_icons() is moved to icon-functions.php (containing the required code).

[davidbaumwald]

Latest patch fails on trunk, so this needs a refreshed patch. With 5.4 Beta 1 approaching, this is being moved to Future Release. If any maintainer or committer feels this can be worked in before 5.4 Beta 1 or can assume ownership during a specific cycle, feel free to update the milestone accordingly.

[SergeyBiryukov]

Note that twentynineteen_post_thumbnail_sizes_attr() from the original list is hooked to wp_get_attachment_image_attributes, so can be left as is.

[SergeyBiryukov]

In 47214:

Twenty Nineteen: Improve code organization in template-functions.php by moving helper functions into their own file.

These functions are moved to inc/helper-functions.php:

• twentynineteen_can_show_post_thumbnail()
• twentynineteen_image_filters_enabled()
• twentynineteen_get_avatar_size()
• twentynineteen_is_comment_by_post_author()
• twentynineteen_get_discussion_data()
• twentynineteen_hsl_hex()

Additionally, twentynineteen_add_dropdown_icons() is moved to inc/icon-functions.php to join twentynineteen_nav_menu_social_icons().

Props akshayar, allancole, grapplerulrich.
Fixes #45984.

[kjellr]

@SergeyBiryukov — did 47214 not include the new inc/helper-functions.php file? I'm seeing a fatal error on trunk when running Twenty Nineteen right now:

[kjellr]

It does seem like 47214 missed the new file. 45984-helper-functions-file.patch​ takes care of this. I had to recreate the file, since I couldn't find the correct patch above. Would someone mind giving this a look to confirm?

[jffng]

I tested TwentyNineteen on trunk and verified the fatal error.

I then applied 45984-helper-functions-file.patch and the theme works as expected.

[SergeyBiryukov]

Replying to kjellr:

did 47214 not include the new inc/helper-functions.php file?

Indeed, thanks for catching that!

[SergeyBiryukov]

In 47242:

Twenty Nineteen: Add the missing inc/helper-functions.php file.

Follow-up to [47214].

Props kjellr, jffng.
Fixes #45984.