Skip to content

Replace unnecessary PHP comment with HTML comment in customize.php#12241

Open
tewariharish wants to merge 1 commit into
WordPress:trunkfrom
tewariharish:tewariharish-patch-1
Open

Replace unnecessary PHP comment with HTML comment in customize.php#12241
tewariharish wants to merge 1 commit into
WordPress:trunkfrom
tewariharish:tewariharish-patch-1

Conversation

@tewariharish

Copy link
Copy Markdown

https://core.trac.wordpress.org/ticket/65497

In src/wp-admin/customize.php (around line 227 and 266), there is a PHP opening tag used solely for an inline comment:

    Since no PHP code is being executed, the PHP tag is unnecessary. This can be replaced with an HTML comment to improve code readability and maintainability.

    WordPress coding standards generally prefer avoiding unnecessary PHP tags when no PHP code is being executed

    Trac ticket:

    Use of AI Tools


    This Pull Request is for code review only. Please keep all other discussion in the Trac ticket. Do not merge this Pull Request. See GitHub Pull Requests for Code Review in the Core Handbook for more details.

    In `src/wp-admin/customize.php` (around line 227 and 266), there is a PHP opening tag used solely for an inline comment:
    
    <ul class="customize-pane-parent"><?php // Panels and sections are managed here via JavaScript ?></ul>
    
    Since no PHP code is being executed, the PHP tag is unnecessary. This can be replaced with an HTML comment to improve code readability and maintainability.
    
    WordPress coding standards generally prefer avoiding unnecessary PHP tags when no PHP code is being executed
    @github-actions

    Copy link
    Copy Markdown

    Hi there! 👋

    Thank you for your contribution to WordPress! 💖

    It looks like this is your first pull request to wordpress-develop. Here are a few things to be aware of that may help you out!

    No one monitors this repository for new pull requests. Pull requests must be attached to a Trac ticket to be considered for inclusion in WordPress Core. To attach a pull request to a Trac ticket, please include the ticket's full URL in your pull request description.

    Pull requests are never merged on GitHub. The WordPress codebase continues to be managed through the SVN repository that this GitHub repository mirrors. Please feel free to open pull requests to work on any contribution you are making.

    More information about how GitHub pull requests can be used to contribute to WordPress can be found in the Core Handbook.

    Please include automated tests. Including tests in your pull request is one way to help your patch be considered faster. To learn about WordPress' test suites, visit the Automated Testing page in the handbook.

    If you have not had a chance, please review the Contribute with Code page in the WordPress Core Handbook.

    The Developer Hub also documents the various coding standards that are followed:

    Thank you,
    The WordPress Project

    @github-actions

    Copy link
    Copy Markdown

    The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

    Core Committers: Use this line as a base for the props when committing in SVN:

    Props harishtewari.
    

    To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

    @github-actions

    Copy link
    Copy Markdown

    Test using WordPress Playground

    The changes in this pull request can previewed and tested using a WordPress Playground instance.

    WordPress Playground is an experimental project that creates a full WordPress instance entirely within the browser.

    Some things to be aware of

    • All changes will be lost when closing a tab with a Playground instance.
    • All changes will be lost when refreshing the page.
    • A fresh instance is created each time the link below is clicked.
    • Every time this pull request is updated, a new ZIP file containing all changes is created. If changes are not reflected in the Playground instance,
      it's possible that the most recent build failed, or has not completed. Check the list of workflow runs to be sure.

    For more details about these limitations and more, check out the Limitations page in the WordPress Playground documentation.

    Test this pull request with WordPress Playground.

    @apermo apermo left a comment

    Copy link
    Copy Markdown

    Choose a reason for hiding this comment

    The reason will be displayed to describe this comment to others. Learn more.

    I am pretty convinced thesre are php comments by design, as the php comment is only visible in code, and not user facing.

    Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

    Labels

    None yet

    Projects

    None yet

    Development

    Successfully merging this pull request may close these issues.

    2 participants