Make WordPress Themes

Opened 7 years ago

Closed 7 years ago

Last modified 7 years ago

#67996 closed theme (not-approved)

THEME: Marmota – 1.0.11

Reported by: emmgfx's profile emmgfx Owned by: timph's profile timph
Priority: previously reviewed Keywords: theme-marmota
Cc: emmgfx@…

Description

Marmota - 1.0.10

Modern theme designed with readability and esthetic in mind.

Theme URL - https://github.com/emmgfx/wp-marmota
Author URL - https://www.viciana.me

Trac Browser - https://themes.trac.wordpress.org/browser/marmota/1.0.10

SVN - https://themes.svn.wordpress.org/marmota/1.0.10
ZIP - https://wordpress.org/themes/download/marmota.1.0.10.zip?nostats=1

Diff with previous version: https://themes.trac.wordpress.org/changeset?old_path=marmota/1.0.8&new_path=marmota/1.0.10

History:

Ticket Summary Status Resolution Owner
#64453 THEME: Marmota – 0.9 closed not-approved poena
#64712 THEME: Marmota – 1.0.2 closed not-approved poena
#65841 THEME: Marmota – 1.0.3 closed not-approved poena
#65869 THEME: Marmota – 1.0.8 closed not-approved zishlife
#67996 THEME: Marmota – 1.0.11 closed not-approved timph

(this ticket)


https://themes.svn.wordpress.org/marmota/1.0.10/screenshot.png
Theme Check Results:

  • RECOMMENDED: No reference to add_theme_support( "custom-header", $args ) was found in the theme. It is recommended that the theme implement this functionality if using an image for the header.
  • RECOMMENDED: No reference to add_theme_support( "custom-background", $args ) was found in the theme. If the theme uses background images or solid colors for the background, then it is recommended that the theme implement this functionality.
  • RECOMMENDED: No reference to add_editor_style() was found in the theme. It is recommended that the theme implement editor styling, so as to make the editor content match the resulting post output in the theme, for a better user experience.

Change History (4)

#1 @themetracbot
7 years ago

  • Summary changed from THEME: Marmota – 1.0.10 to THEME: Marmota – 1.0.11

Marmota - 1.0.11

Modern theme designed with readability and esthetic in mind.

Theme URL - https://github.com/emmgfx/wp-marmota
Author URL - https://www.viciana.me

Trac Browser - https://themes.trac.wordpress.org/browser/marmota/1.0.11

SVN - https://themes.svn.wordpress.org/marmota/1.0.11
ZIP - https://wordpress.org/themes/download/marmota.1.0.11.zip?nostats=1

Diff with previous version: https://themes.trac.wordpress.org/changeset?old_path=marmota/1.0.10&new_path=marmota/1.0.11

History:

Ticket Summary Status Resolution Owner
#64453 THEME: Marmota – 0.9 closed not-approved poena
#64712 THEME: Marmota – 1.0.2 closed not-approved poena
#65841 THEME: Marmota – 1.0.3 closed not-approved poena
#65869 THEME: Marmota – 1.0.8 closed not-approved zishlife
#67996 THEME: Marmota – 1.0.11 closed not-approved timph

(this ticket)


https://themes.svn.wordpress.org/marmota/1.0.11/screenshot.png
Theme Check Results:

  • RECOMMENDED: No reference to add_theme_support( "custom-header", $args ) was found in the theme. It is recommended that the theme implement this functionality if using an image for the header.
  • RECOMMENDED: No reference to add_theme_support( "custom-background", $args ) was found in the theme. If the theme uses background images or solid colors for the background, then it is recommended that the theme implement this functionality.
  • RECOMMENDED: No reference to add_editor_style() was found in the theme. It is recommended that the theme implement editor styling, so as to make the editor content match the resulting post output in the theme, for a better user experience.

#2 @timph
7 years ago

  • Owner set to timph
  • Status changed from new to reviewing

#3 @timph
7 years ago

Hey there @emmgfx, thanks for your submission! There are a few issues left that need to be address before the theme is ready to go. There's licensing issues, code changes, and further down suggestions that should be addressed as you work on this theme. Since there are more than 3 distinct issues with this submission, I'm going to close the ticket, but don't let that get you discouraged! We don't hard reject themes, and you'll be able to resubmit after you've fixed some issues. I'd encourage you to read over more of the theme review requirements, and double check things with Theme Sniffer and Theme Check before you resubmit.

Issues

  1. When I try to open screenshot.png in your theme I get a fatal error: Fatal error reading PNG image file: Not a PNG file. Theme Sniffer detects that this is a .gif file that was renamed. You should convert the file into a png, not just rename it.

screenshot guidelines reference:
https://developer.wordpress.org/themes/release/required-theme-files/
https://make.wordpress.org/themes/handbook/review/required/#screenshot

  1. The Contributors field in readme.txt should be a comma separated list of WordPress.org usernames:

https://themes.trac.wordpress.org/browser/marmota/1.0.11/readme.txt#L2

  1. Theme missing call to wp_body_open by hook or function immediately after the body open tag.

Read this page for how it should be implemented.

found in: https://themes.trac.wordpress.org/browser/marmota/1.0.11/header.php#L10

  1. The sections added should follow the format from the Sample Readme in their readme.txt file. The "Changelog" shouldn't be a link to your github changelog, it should contain changelog information. I would highly suggest following WordPress' recommended practice for a good way to handle it.
  1. The images referenced are unsplash license, and are in the list of restricted license image providers. You will need to choose different images from another image provider. I would suggest checking out the recommended providers from the theme review guidelines.
  1. Material Design Icons referenced in LICENSE file is not compatible with the GPL in the way you're using them. The referenced license mentioned is for the compiled font, and does not apply/cover the individual SVGs. These currently are unlicensed and incompatible with WordPress.org's guidelines. There is an open issue on GitHub to hopefully resolve that one day, but until that actually happens all the images in /assets/img/icons and /assets/img/social need to be removed/replaced with compatible alternatives. I would recommend that you follow their suggestions to obtain different icons from Google's Material Design Icons or Font Awesome as they basically have similar for all in those folders.
  1. Bootstrap 4 from npm registry contains the bundled and non-bundle minified/non-minified versions of each. You should pick the minified/non-minified of either the bundled or unbundled one and remove the rest. The difference is that the bundled version contains Popper.js: https://github.com/twbs/bootstrap#whats-included and you should not include which ever one you're not using.
  1. You should also document inline SVGs that are used in your resources section, such as the ones used here:

https://themes.trac.wordpress.org/browser/marmota/1.0.11/pagination-posts.php
https://themes.trac.wordpress.org/browser/marmota/1.0.11/searchform-desktop.php#L6
https://themes.trac.wordpress.org/browser/marmota/1.0.11/404.php#L8

  1. Missing attribution in resources section for WP Bootstrap Nav Walker.
  1. You don't need to do echo __() as there's a core provided function to save you time with _e(). https://developer.wordpress.org/reference/functions/_e/ For example here:

https://themes.trac.wordpress.org/browser/marmota/1.0.11/searchform.php#L4

You might even consider esc_html_e() to be appropriate there: https://developer.wordpress.org/reference/functions/esc_html_e/

  1. Middle may not be omitted from ternary operators in PHP < 5.3 in PHP error marmota/functions.php - see theme sniffer results below.

You've indicated this theme is compatible for version of WordPress before 5.2, which has a minimum PHP requirement of 5.2 in your readme.txt: https://themes.trac.wordpress.org/browser/marmota/1.0.11/readme.txt#L3

  1. Remove meta description from header.php file: https://themes.trac.wordpress.org/browser/marmota/1.0.11/header.php#L6 This sets the meta description on every page to the tagline text. This can be bad for SEO, and themes aren't supposed to try to provide SEO options like that anyways.
  1. You include a custom logo which provides cropping abilities. When the image is added to the page it looks like this is being forced to a certain dimension with CSS or something. This needs to display the image at the cropped size, and there is also the ability to set a ratio for the dimensions, and recommended crop size if needed.

me cropping: http://i.imgur.com/k1jElBZ.png
what happens: http://i.imgur.com/7UbbCQk.png

Suggestions

  1. The LICENSE file is not the full text of the license. This isn't a requirement listed anywhere, but I just wanted to inform you how that file is generally interpreted by other software and implications/why it should be changed.

Luckily, you use github so it's a super easy fix, you just delete the file, and create a new one with the license template choosing the one you need. Just follow this answer's screenshots on stackoverflow if you're unsure of what/where to click: https://stackoverflow.com/a/37895659/6805287

The license file is what your license is, not licenses of dependencies included. For purposes of WordPress themes, we ask that they are added in readme.txt to the == Resources == section - but that's not always desired if you have a long list of dependencies like this theme's resources.

There's not currently a documented standard on where the best place is for these in terms of an external file outside of readme.txt, but I would recommend adding them to a resources.txt so that it matches the section of the readme.txt it belongs to. This will help keep consistency for machine parsing of theme data. Github introducing their license template has really helped a lot of OSS license scanners to excel due to providing a consistent naming convention. Some project still stray outside of this, and rename their license file to license.txt or license.md - but they still include the same license template data that gets parsed.

For example GPL-3.0-or-later: https://github.com/timelsass/wp-license-compatibility/blob/master/license-data.json#L2293

We can reliably use spdx.org's license data to get a JSON template that includes all the string that match a particular license for a project: https://spdx.org/licenses/GPL-3.0-or-later.json - tools that consume this data are typically compliance testing tools, which is something currently done manually (very loosely) for .org theme submissions during the review phase :)!

  1. When I click on the search icon, there's no way to close the search panel. It's not a requirement to fix, but it was a little odd not to be able to get back to the homepage without typing in a search query, go to that page, and press back.
  1. shrink-to-fit=no in header.php isn't needed these days at:

https://themes.trac.wordpress.org/browser/marmota/1.0.11/header.php#L5

Here's the PR when it was removed from twbs' example, similar PRs for html5bp and other popular frameworks exist too.

  1. Typo: https://themes.trac.wordpress.org/browser/marmota/1.0.11/readme.txt#L28
  1. Custom sections in readme.txt are okay, but it can be a little weird (once things are parsed and this content is used for the display of the theme's information ). You've added == Copyright ==, which is fine, but think if this were displayed on WordPress.org - how would they view the file you're instructing them to view? It's not overly important, so you might want to remove it, or just correct it so it makes sense in that context.

Theme Sniffer Results

Keep in mind errors are usually things that must be fixed, and warnings are things might need to be fixed after manually inspecting the usage. It can be helpful to mark your warnings as you inspect them with PHPCS annotations to ignore the warnings. This lets them be removed from your Theme Sniffer scans if you toggle the annotations checkbox, and that way you don't end up checking them over and over. It can also help flag to a review that you took the time to ensure that things were just as they should be!

FILE: /home/triayx60z1t5/public_html/wp-content/themes/marmota/404.php
--------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------------------------------------
 5 | WARNING | All output should be run through an escaping function (see the Security sections in the
   |         | WordPress Developer Handbooks), found '__'.
   |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
--------------------------------------------------------------------------------------------------------------


FILE: /home/triayx60z1t5/public_html/wp-content/themes/marmota/article-detail.php
--------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 3 WARNINGS AFFECTING 3 LINES
--------------------------------------------------------------------------------------------------------------
 37 | WARNING | All output should be run through an escaping function (see the Security sections in the
    |         | WordPress Developer Handbooks), found '__'.
    |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
 52 | WARNING | All output should be run through an escaping function (see the Security sections in the
    |         | WordPress Developer Handbooks), found '$marmota_previous_link'.
    |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
 58 | WARNING | All output should be run through an escaping function (see the Security sections in the
    |         | WordPress Developer Handbooks), found '$marmota_next_link'.
    |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
--------------------------------------------------------------------------------------------------------------


FILE: /home/triayx60z1t5/public_html/wp-content/themes/marmota/article-featured.php
--------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
--------------------------------------------------------------------------------------------------------------
 24 | WARNING | All output should be run through an escaping function (see the Security sections in the
    |         | WordPress Developer Handbooks), found '__'.
    |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
 26 | WARNING | All output should be run through an escaping function (see the Security sections in the
    |         | WordPress Developer Handbooks), found '__'.
    |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
--------------------------------------------------------------------------------------------------------------


FILE: /home/triayx60z1t5/public_html/wp-content/themes/marmota/article-vertical.php
--------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
--------------------------------------------------------------------------------------------------------------
 21 | WARNING | All output should be run through an escaping function (see the Security sections in the
    |         | WordPress Developer Handbooks), found '__'.
    |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
 23 | WARNING | All output should be run through an escaping function (see the Security sections in the
    |         | WordPress Developer Handbooks), found '__'.
    |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
--------------------------------------------------------------------------------------------------------------


FILE: /home/triayx60z1t5/public_html/wp-content/themes/marmota/comments.php
--------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 4 WARNINGS AFFECTING 2 LINES
--------------------------------------------------------------------------------------------------------------
  6 | WARNING | All output should be run through an escaping function (see the Security sections in the
    |         | WordPress Developer Handbooks), found '__'.
    |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
  6 | WARNING | A gettext call containing placeholders was found, but was not accompanied by a "translators:"
    |         | comment on the line above to clarify the meaning of the placeholders.
    |         | (WordPress.WP.I18n.MissingTranslatorsComment)
  6 | WARNING | All output should be run through an escaping function (see the Security sections in the
    |         | WordPress Developer Handbooks), found 'get_comments_number'.
    |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
 34 | WARNING | All output should be run through an escaping function (see the Security sections in the
    |         | WordPress Developer Handbooks), found '__'.
    |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
--------------------------------------------------------------------------------------------------------------


FILE: /home/triayx60z1t5/public_html/wp-content/themes/marmota/context-detail.php
--------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
--------------------------------------------------------------------------------------------------------------
  8 | WARNING | All output should be run through an escaping function (see the Security sections in the
    |         | WordPress Developer Handbooks), found '$marmota_tags_list'.
    |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
 10 | WARNING | All output should be run through an escaping function (see the Security sections in the
    |         | WordPress Developer Handbooks), found '__'.
    |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
--------------------------------------------------------------------------------------------------------------


FILE: /home/triayx60z1t5/public_html/wp-content/themes/marmota/footer.php
--------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 3 WARNINGS AFFECTING 2 LINES
--------------------------------------------------------------------------------------------------------------
 15 | WARNING | All output should be run through an escaping function (see the Security sections in the
    |         | WordPress Developer Handbooks), found 'get_bloginfo'.
    |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
 21 | WARNING | All output should be run through an escaping function (see the Security sections in the
    |         | WordPress Developer Handbooks), found '$marmota_url'.
    |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
 21 | WARNING | All output should be run through an escaping function (see the Security sections in the
    |         | WordPress Developer Handbooks), found 'str_replace'.
    |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
--------------------------------------------------------------------------------------------------------------


FILE: /home/triayx60z1t5/public_html/wp-content/themes/marmota/functions.php
--------------------------------------------------------------------------------------------------------------
FOUND 1 ERROR AFFECTING 1 LINE
--------------------------------------------------------------------------------------------------------------
 9 | ERROR | Middle may not be omitted from ternary operators in PHP < 5.3
   |       | (PHPCompatibility.Operators.NewShortTernary.MiddleMissing)
--------------------------------------------------------------------------------------------------------------


FILE: /home/triayx60z1t5/public_html/wp-content/themes/marmota/header.php
--------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
--------------------------------------------------------------------------------------------------------------
 23 | WARNING | All output should be run through an escaping function (see the Security sections in the
    |         | WordPress Developer Handbooks), found 'get_bloginfo'.
    |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
 26 | WARNING | All output should be run through an escaping function (see the Security sections in the
    |         | WordPress Developer Handbooks), found 'get_bloginfo'.
    |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
--------------------------------------------------------------------------------------------------------------


FILE: /home/triayx60z1t5/public_html/wp-content/themes/marmota/includes/customize-social.php
--------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------------------------------------
 42 | WARNING | A gettext call containing placeholders was found, but was not accompanied by a "translators:"
    |         | comment on the line above to clarify the meaning of the placeholders.
    |         | (WordPress.WP.I18n.MissingTranslatorsComment)
--------------------------------------------------------------------------------------------------------------


FILE: /home/triayx60z1t5/public_html/wp-content/themes/marmota/includes/customize.php
--------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
--------------------------------------------------------------------------------------------------------------
 26 | WARNING | Check that require_once is not being used to load template files. "get_template_part()"
    |         | should be used to load template files.
    |         | (WPThemeReview.CoreFunctionality.FileInclude.FileIncludeFound)
 27 | WARNING | Check that require_once is not being used to load template files. "get_template_part()"
    |         | should be used to load template files.
    |         | (WPThemeReview.CoreFunctionality.FileInclude.FileIncludeFound)
--------------------------------------------------------------------------------------------------------------


FILE: /home/triayx60z1t5/public_html/wp-content/themes/marmota/includes/menus.php
--------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------------------------------------
 3 | WARNING | Check that require_once is not being used to load template files. "get_template_part()" should
   |         | be used to load template files.
   |         | (WPThemeReview.CoreFunctionality.FileInclude.FileIncludeFound)
--------------------------------------------------------------------------------------------------------------


FILE: /home/triayx60z1t5/public_html/wp-content/themes/marmota/pagination-posts.php
--------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------------------------------------
 11 | WARNING | [x] To help prevent PHP "headers already send" errors the PHP closing tag at the end of the
    |         |     file should be removed. (PSR2.Files.ClosingTag.NotAllowed)
--------------------------------------------------------------------------------------------------------------
PHPCBF CAN FIX THE 1 MARKED SNIFF VIOLATIONS AUTOMATICALLY
--------------------------------------------------------------------------------------------------------------


FILE: /home/triayx60z1t5/public_html/wp-content/themes/marmota/search.php
--------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 2 WARNINGS AFFECTING 2 LINES
--------------------------------------------------------------------------------------------------------------
  7 | WARNING | All output should be run through an escaping function (see the Security sections in the
    |         | WordPress Developer Handbooks), found '__'.
    |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
 13 | WARNING | All output should be run through an escaping function (see the Security sections in the
    |         | WordPress Developer Handbooks), found '__'.
    |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
--------------------------------------------------------------------------------------------------------------


FILE: /home/triayx60z1t5/public_html/wp-content/themes/marmota/searchform-desktop.php
--------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------------------------------------
 5 | WARNING | All output should be run through an escaping function (see the Security sections in the
   |         | WordPress Developer Handbooks), found '__'.
   |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
--------------------------------------------------------------------------------------------------------------


FILE: /home/triayx60z1t5/public_html/wp-content/themes/marmota/searchform.php
--------------------------------------------------------------------------------------------------------------
FOUND 0 ERRORS AND 1 WARNING AFFECTING 1 LINE
--------------------------------------------------------------------------------------------------------------
 4 | WARNING | All output should be run through an escaping function (see the Security sections in the
   |         | WordPress Developer Handbooks), found '__'.
   |         | (WordPress.Security.EscapeOutput.OutputNotEscaped)
--------------------------------------------------------------------------------------------------------------
Last edited 7 years ago by timph (previous) (diff)

#4 @timph
7 years ago

  • Resolution set to not-approved
  • Status changed from reviewing to closed
Note: See TracTickets for help on using tickets.