Twenty Seventeen: Two different function, which return same result

[mukesh27]

Many apologies if this is a duplicate. I have searched but did not find it yet posted.

Theme: Twenty Seventeen
Version: 1.4 (not tested below 1.4)

The theme have two different functions twentyseventeen_is_frontpage and twentyseventeen_is_static_front_page both have return same result so why we create two different function as both function return same result? They have to remove "twentyseventeen_is_static_front_page" function use in one place.

[soulseekah]

Both functions are being used in child themes, etc. we can't just remove them I think:

• ​https://github.com/search?q=twentyseventeen_is_static_front_page&type=Code&utf8=%E2%9C%93
• ​https://github.com/search?utf8=%E2%9C%93&q=twentyseventeen_is_frontpage&type=Code

[mukesh27]

@soulseekah above both link are not working.

My question is below both the functions return same result then wy should we use two different function?

twentyseventeen_is_static_front_page function

<?php
function twentyseventeen_is_static_front_page() {
   return ( is_front_page() && ! is_home() );
}

twentyseventeen_is_frontpage function

<?php
function twentyseventeen_is_frontpage() {
   return ( is_front_page() && ! is_home() );
}

[swissspidy]

@mukesh27 You need to be logged in on GitHub in order for the links to work.

This should rather look something like this (or the other way around):

function twentyseventeen_is_frontpage() {
  return twentyseventeen_is_static_front_page();
}

[sabernhardt]

makes twentyseventeen_is_static_front_page() an alias of twentyseventeen_is_frontpage()

[sabernhardt]

I think the name twentyseventeen_is_static_front_page() is more self-explanatory, but the other function is much more common and it was created first.

• [38833] imported the theme from GitHub with twentyseventeen_is_frontpage().
• [38986] added twentyseventeen_is_static_front_page(), still before version 1.0.

[audrasjb]

Replying to sabernhardt:

I think the name twentyseventeen_is_static_front_page() is more self-explanatory, but the other function is much more common and it was created first.

• [38833] imported the theme from GitHub with twentyseventeen_is_frontpage().
• [38986] added twentyseventeen_is_static_front_page(), still before version 1.0.

Given both were added before version 1.0, I think we can safely go with twentyseventeen_is_static_front_page() which is indeed more self-explanatory 👍

[SergeyBiryukov]

I think 43515.1.patch​ looks good.

twentyseventeen_is_frontpage() is indeed more common and used in other parts of the theme, while twentyseventeen_is_static_front_page() was only ever used as a Customizer control callback.

Since the theme is no longer in active development, making the latter an alias of the former would minimize the changes, otherwise I think we'd have to update all instances of twentyseventeen_is_frontpage() in the theme.

[Hareesh Pillai]

Just to be sure - I hope we don't need to handle this in the doing_it_wrong or deprecated.php file?

[sabernhardt]

I think both functions would remain equally valid, but with one canonical.

To consider switching it the other way, I ​drafted a PR that edits multiple files to use the twentyseventeen_is_static_front_page function throughout the theme (and it includes two unrelated documentation changes that probably belong on #57840 instead). If that direction might be preferable, I could move it from my fork to the main repo for review.

Code outside Twenty Seventeen:

• GitHub code search gives ​many more results with twentyseventeen_is_frontpage than the ​results with twentyseventeen_is_static_front_page, which suggests 43515.1.patch​ would be better.
• The directory search is much closer. The twentyseventeen_is_frontpage function is only operational in ​two of the four plugins in the results list, and a rather ​popular plugin uses twentyseventeen_is_static_front_page. ​Three child themes use twentyseventeen_is_frontpage, but the ​other function's results only include Twenty Seventeen.

[audrasjb]

I think both approaches would work. Given the theme is not in active development anymore, I'd suggest to go with 43515.1.patch so we can ship this before 6.3 beta 1. Thoughts?

[Hareesh Pillai]

43515.1.patch looks good.
This approach seems better, considering the amount of changes needed in both the approaches.

[sabernhardt]

Marking for commit then.

[audrasjb]

In 56012:

Twenty Seventeen: Make twentyseventeen_is_static_front_page() an alias of twentyseventeen_is_frontpage().

Since both functions return the exact same thing, this changeset makes twentyseventeen_is_static_front_page() an alias of twentyseventeen_is_frontpage()
and updates the related docblocks and function callback.

Props mukesh27, soulseekah, swissspidy, sabernhardt, audrasjb, SergeyBiryukov, hareesh-pillai.
Fixes #43515.