Code Quality Fixes #71

apermo · 2025-04-05T07:20:49Z

This PR includes Code Style, PHPdoc and other code quality fixes.

Pushes with just phpcbf are marked as such.

Besides a few marked places not output should be altered.

…to action and return value is not used

…hp and template-functions.php

…image.php

…owance in composer.json

removed unused globals fixed code style fixed phpdoc

…bactions.php

…ng in widgets.php

…s.php

…lements

… in entry-share.php

apermo

Questions.

apermo · 2025-04-05T07:38:09Z

template-parts/entry-taxonomy.php

-	<?php printf( __( '%1$s', 'autonomie' ), $categories_list ); ?>
+	<?php
+	// translators: %1$s Category list in HTML.
+	printf( __( '%1$s', 'autonomie' ), $categories_list );


@pfefferle Why did you use the translation here in the first place?

apermo · 2025-04-05T07:38:21Z

template-parts/entry-taxonomy.php

-	<?php printf( __( '%1$s', 'autonomie' ), $tags_list ); ?>
+	<?php
+	// translators: %1$s Tag list in HTML.
+	printf( __( '%1$s', 'autonomie' ), $tags_list );


Same as above.

… template files

…e template files

apermo · 2025-04-05T08:07:52Z

functions.php

 		?>
 		<li <?php comment_class(); ?> id="li-comment-<?php comment_ID(); ?>">
-			<article id="comment-<?php comment_ID(); ?>" class="comment <?php $comment->comment_type; ?>" itemprop="comment" itemscope itemtype="https://schema.org/Comment">
+			<article id="comment-<?php comment_ID(); ?>" class="comment <?php echo $comment->comment_type; ?>" itemprop="comment" itemscope itemtype="https://schema.org/Comment">


@pfefferle Review here, this echo was missing before, please verify that this has no sideeffects, alternatively we can remove the output.

apermo · 2025-04-05T08:10:08Z

comments.php

+					/* translators:
+					%1$s: number of comments, mind to add this if your language uses singular for more than just n=1
+					%2$s: post title
+					*/
+					_n(
+						'One thought on &ldquo;%2$s&rdquo;', // phpcs:ignore WordPress.WP.I18n.MissingSingularPlaceholder -- Translator instructions added.


phpcs: WordPress.WP.I18n.MissingSingularPlaceholder: Missing singular placeholder, needed for some languages. See https://codex.wordpress.org/I18n_for_WordPress_Developers#Plurals

The phpcs error here noted that the placeholder must be added, since slavic and some other languages have multiple singulars, I assume by adding a more precise translators comment, this should be covered.

apermo · 2025-04-05T08:16:37Z

@pfefferle I'm ready with the code style fixes and review.

stale · 2025-08-03T12:29:55Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

pfefferle · 2025-08-03T17:29:28Z

Keep

Copilot

Pull Request Overview

This PR standardizes code formatting across WordPress theme template files according to PHP coding standards, specifically implementing consistent indentation, spacing, and style patterns while maintaining the same functional output.

Key changes include:

Converting single-line PHP function calls to multi-line format with proper indentation
Adding missing PHP opening tags and proper formatting for closing statements
Standardizing comment formatting and adding translator comments for internationalization
Updating version requirements and coding standard compliance

Reviewed Changes

Copilot reviewed 42 out of 45 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
templates/*.php	Reformatted `wp_link_pages()` function calls to multi-line format with consistent indentation
template-parts/*.php	Added translator comments for internationalization and improved PHP formatting
*.php (root files)	Standardized PHP opening/closing tags and while loop formatting
includes/*.php	Enhanced PHPDoc comments, improved code structure, and fixed coding standard violations
integrations/*.php	Updated PHPDoc formatting and improved function documentation
composer.json	Updated PHP version requirements and added plugin configuration
readme.md	Updated WordPress and PHP compatibility versions

Copilot · 2025-08-03T17:32:53Z

template-parts/entry-share.php

 	<p>
 		<label for="entry-summary"><?php _e( 'HTML', 'autonomie' ); ?></label>
-		<textarea id="entry-summary" class="code" type="text" rows="5" cols="70">&lt;cite class=&quot;h-cite&quot;&gt;&lt;a class=&quot;u-url p-name&quot; href=&quot;<?php echo get_permalink(); ?>&quot;&gt;<?php echo get_the_title(); ?>&lt;/a&gt; (&lt;span class=&quot;p-author h-card&quot; title=&quot;<?php echo get_the_author(); ?>&quot;&gt;<?php echo get_the_author(); ?>&lt;/span&gt; &lt;time class=&quot;dt-published&quot; datetime=&quot;<?php echo get_the_date( 'c' ); ?>&quot;&gt;<?php echo get_the_date(); ?>&lt;/time&gt;)&lt;/cite&gt;</textarea>
+		<textarea id="entry-summary" class="code" rows="5" cols="70">&lt;cite class=&quot;h-cite&quot;&gt;&lt;a class=&quot;u-url p-name&quot; href=&quot;<?php echo get_permalink(); ?>&quot;&gt;<?php echo get_the_title(); ?>&lt;/a&gt; (&lt;span class=&quot;p-author h-card&quot; title=&quot;<?php echo get_the_author(); ?>&quot;&gt;<?php echo get_the_author(); ?>&lt;/span&gt; &lt;time class=&quot;dt-published&quot; datetime=&quot;<?php echo get_the_date( 'c' ); ?>&quot;&gt;<?php echo get_the_date(); ?>&lt;/time&gt;)&lt;/cite&gt;</textarea>


The type="text" attribute was removed from the textarea element, but this doesn't address the underlying security concern. The content includes unescaped output from get_permalink(), get_the_title(), and get_the_author() functions which should be escaped with esc_url(), esc_html(), and esc_html() respectively to prevent XSS vulnerabilities.

Copilot · 2025-08-03T17:32:53Z

template-parts/entry-share.php

 	<p>
 		<label for="entry-blockquote"><?php _e( 'HTML', 'autonomie' ); ?></label>
-		<textarea id="entry-blockquote" class="code" type="text" rows="5" cols="70">&lt;blockquote&gt;&lt;p&gt;<?php echo get_the_excerpt(); ?>&lt;/p&gt;&lt;small&gt;—&nbsp;by &lt;a href=&quot;<?php echo get_permalink(); ?>&quot; class=&quot;h-card&quot; title=&quot;<?php echo get_the_author(); ?>&quot;&gt;<?php echo get_the_author(); ?>&lt;/a&gt;&lt;/small&gt;&lt;/blockquote&gt;</textarea>
+		<textarea id="entry-blockquote" class="code" rows="5" cols="70">&lt;blockquote&gt;&lt;p&gt;<?php echo get_the_excerpt(); ?>&lt;/p&gt;&lt;small&gt;—&nbsp;by &lt;a href=&quot;<?php echo get_permalink(); ?>&quot; class=&quot;h-card&quot; title=&quot;<?php echo get_the_author(); ?>&quot;&gt;<?php echo get_the_author(); ?>&lt;/a&gt;&lt;/small&gt;&lt;/blockquote&gt;</textarea>


Similar to the previous textarea, this content includes unescaped output from get_the_excerpt(), get_permalink(), and get_the_author() functions. These should be properly escaped with esc_html() for text content and esc_url() for URLs to prevent XSS vulnerabilities.

Copilot · 2025-08-03T17:32:53Z

functions.php

 		?>
 		<li <?php comment_class(); ?> id="li-comment-<?php comment_ID(); ?>">
-			<article id="comment-<?php comment_ID(); ?>" class="comment <?php $comment->comment_type; ?>" itemprop="comment" itemscope itemtype="https://schema.org/Comment">
+			<article id="comment-<?php comment_ID(); ?>" class="comment <?php echo $comment->comment_type; ?>" itemprop="comment" itemscope itemtype="https://schema.org/Comment">


The $comment->comment_type output should be escaped with esc_attr() since it's being used in a class attribute to prevent potential XSS vulnerabilities.

Suggested change

<article id="comment-<?php comment_ID(); ?>" class="comment <?php echo $comment->comment_type; ?>" itemprop="comment" itemscope itemtype="https://schema.org/Comment">

<article id="comment-<?php comment_ID(); ?>" class="comment <?php echo esc_attr( $comment->comment_type ); ?>" itemprop="comment" itemscope itemtype="https://schema.org/Comment">

Copilot · 2025-08-03T17:32:54Z

template-parts/entry-footer.php

 		<div class="entry-actions">
 			<?php if ( comments_open() || ( '0' !== get_comments_number() && ! comments_open() ) ) : ?>
-			<indie-action do="reply" width="<?php the_permalink(); ?>"><div class="comments-link"><?php comments_popup_link( __( 'Leave a comment', 'autonomie' ), __( '1 Comment', 'autonomie' ), __( '% Comments', 'autonomie' ) ); ?></div></indie-action>
+			<indie-action do="reply" with="<?php the_permalink(); ?>"><div class="comments-link"><?php comments_popup_link( __( 'Leave a comment', 'autonomie' ), __( '1 Comment', 'autonomie' ), __( '% Comments', 'autonomie' ) ); ?></div></indie-action>


The the_permalink() function output should be escaped with esc_url() since it's being used in an HTML attribute to prevent potential XSS vulnerabilities.

Copilot · 2025-08-03T17:32:54Z

template-parts/entry-footer.php

 		<?php if ( comments_open() || ( '0' !== get_comments_number() && ! comments_open() ) ) : ?>
 		<div class="entry-actions">
-			<indie-action do="reply" width="<?php the_permalink(); ?>"><div class="comments-link"><?php comments_popup_link( __( 'Leave a comment', 'autonomie' ), __( '1 Comment', 'autonomie' ), __( '% Comments', 'autonomie' ) ); ?></div></indie-action>
+			<indie-action do="reply" with="<?php the_permalink(); ?>"><div class="comments-link"><?php comments_popup_link( __( 'Leave a comment', 'autonomie' ), __( '1 Comment', 'autonomie' ), __( '% Comments', 'autonomie' ) ); ?></div></indie-action>


The the_permalink() function output should be escaped with esc_url() since it's being used in an HTML attribute to prevent potential XSS vulnerabilities.

Copilot · 2025-08-03T17:32:54Z

includes/semantics.php


 	if ( ! $classes ) {
-		return;
+		return '';


The function autonomie_get_the_semantics() is documented to return a string but was previously returning null (via return;) when $classes is empty. The change to return ''; is correct and consistent with the function's purpose of building attribute strings.

Copilot · 2025-08-03T17:32:55Z

includes/semantics.php


 	if ( empty( $terms ) ) {
-		return false;
+		return array();


The function autonomie_term_links_tag() was previously returning false when no terms are found, but now returns an empty array. This change improves consistency since the function is documented to return an array and other parts of the code likely expect an array return type.

stale · 2025-12-01T22:38:16Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

pfefferle · 2025-12-02T09:47:12Z

keep!

apermo added 20 commits April 5, 2025 08:23

refactor: remove return values, as autonomie_save_post is hooked in…

eec0192

…to action and return value is not used

refactor: simplify unset calls for query variables in compat.php

ba9cf2f

refactor: fix phpdoc return types for post format functions in feed.p…

3aeee73

…hp and template-functions.php

refactor: reorder condition for post format feed discovery in feed.php

976f1cb

refactor: update comments for clarity in customizer.php and featured-…

5daf2a4

…image.php

refactor: update phpdoc for parameters and return types in compat.php

6bf8f11

refactor: improve code clarity and consistency in semantics.php

8b49e3c

refactor: improve comment clarity in featured-image.php

fbe89be

chore: update PHP version requirement to 7.4 and configure plugin all…

c8b735e

…owance in composer.json

refactor: enhance code clarity and consistency in template-functions.php

979168a

removed unused globals fixed code style fixed phpdoc

refactor: improve phpdoc clarity for parameters and return type in we…

2306e22

…bactions.php

refactor: streamline require statements and improve function formatti…

459456e

…ng in widgets.php

refactor: improve phpdoc clarity and consistency in activitypub.php

bfb4ce5

refactor: improve phpdoc clarity and consistency in post-kinds.php

d079ed4

refactor: improve code formatting and consistency in syndication-link…

70cf320

…s.php

refactor: fix attribute name from 'width' to 'with' in indie-action e…

9fd738f

…lements

refactor: improve code formatting and readability in entry-header.php

7c23915

refactor: improve code formatting and consistency in entry-nav.php

c7b2805

refactor: Removed unsupported attribute type="text" from textarea…

0c457dd

… in entry-share.php

refactor: Removed unsupported attribute type="text" from textarea…

4b52d98

… in entry-share.php

apermo commented Apr 5, 2025

View reviewed changes

apermo added 8 commits April 5, 2025 09:39

refactor: fix indentation in page-banner.php

d5cc65d

chore: phpcbf changes in /templates/

7af6a78

refactor: phpcbf, improve code formatting and consistency in multiple…

b5d0bbd

… template files

refactor: improve translator comments for clarity in comments.php

cbce161

chore: update tested version and PHP requirements in readme.md

0eb808a

refactor: phpcbf - improve code readability and formatting in multipl…

534a4e0

…e template files

fix: update profile links to use HTTPS for improved security

0fc955d

refactor: phpcbf and added missing echo to functions.php

167b835

apermo marked this pull request as ready for review April 5, 2025 08:04

apermo commented Apr 5, 2025

View reviewed changes

stale bot added the wontfix label Aug 3, 2025

stale bot removed the wontfix label Aug 3, 2025

pfefferle self-assigned this Aug 3, 2025

pfefferle requested review from Copilot and pfefferle August 3, 2025 17:31

Copilot AI reviewed Aug 3, 2025

View reviewed changes

stale bot added the wontfix label Dec 1, 2025

stale bot removed the wontfix label Dec 2, 2025

	<article id="comment-<?php comment_ID(); ?>" class="comment <?php echo $comment->comment_type; ?>" itemprop="comment" itemscope itemtype="https://schema.org/Comment">
	<article id="comment-<?php comment_ID(); ?>" class="comment <?php echo esc_attr( $comment->comment_type ); ?>" itemprop="comment" itemscope itemtype="https://schema.org/Comment">

Uh oh!

Code Quality Fixes #71

Are you sure you want to change the base?

Code Quality Fixes #71

Uh oh!

Conversation

apermo commented Apr 5, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

apermo left a comment

Choose a reason for hiding this comment

Uh oh!

apermo Apr 5, 2025

Choose a reason for hiding this comment

Uh oh!

apermo Apr 5, 2025

Choose a reason for hiding this comment

Uh oh!

apermo Apr 5, 2025

Choose a reason for hiding this comment

Uh oh!

apermo Apr 5, 2025

Choose a reason for hiding this comment

Uh oh!

apermo commented Apr 5, 2025

Uh oh!

stale bot commented Aug 3, 2025

Uh oh!

pfefferle commented Aug 3, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Aug 3, 2025

Choose a reason for hiding this comment

Uh oh!

stale bot commented Dec 1, 2025

Uh oh!

pfefferle commented Dec 2, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

apermo commented Apr 5, 2025 •

edited

Loading