Skip to content

Adds documentation for PregQuoteDelimiter#2487

Closed
tikifez wants to merge 5 commits intoWordPress:developfrom
tikifez:docs/WordPress.PHP.PregQuoteDelimiter
Closed

Adds documentation for PregQuoteDelimiter#2487
tikifez wants to merge 5 commits intoWordPress:developfrom
tikifez:docs/WordPress.PHP.PregQuoteDelimiter

Conversation

@tikifez
Copy link
Copy Markdown
Contributor

@tikifez tikifez commented Sep 17, 2024 •
edited
Loading

Related to #1722

@jrfnl jrfnl mentioned this pull request Sep 17, 2024
Open
61 tasks
@rodrigoprimo
Copy link
Copy Markdown
Collaborator

rodrigoprimo commented Sep 17, 2024

Just documenting here that I chatted in person with @tikifez and he will add valid and invalid examples. No need to review this PR yet.

@tikifez
Copy link
Copy Markdown
Contributor Author

tikifez commented Sep 17, 2024

Added code comparison with valid and invalid examples.

1 similar comment
@tikifez
Copy link
Copy Markdown
Contributor Author

tikifez commented Sep 17, 2024

Added code comparison with valid and invalid examples.

rodrigoprimo
rodrigoprimo requested changes Sep 17, 2024
View reviewed changes
Copy link
Copy Markdown
Collaborator

@rodrigoprimo rodrigoprimo left a comment

Choose a reason for hiding this comment

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

Thanks for working on this PR, @tikifez! I'm not a maintainer of the project so take my review with a grain of salt. That being said, I left some comments based on my own experience creating PHPCS and WPCS sniffs.

Also, please make sure to include a reference to the parent issue as mentioned in the description of #1722:

Please mention this issue in your pull request description Related to #1722 so your pull request will show up in this issue.

WordPress/Docs/PHP/PregQuoteDelimiterStandard.xml Outdated
title="Preg Quote Delimiter"
>
<standard>
<![CDATA[
Copy link
Copy Markdown
Collaborator

@rodrigoprimo rodrigoprimo Sep 17, 2024

Choose a reason for hiding this comment

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

<![CDATA should be aligned with <standard>. Here is an example of a recently added documentation: https://github.com/rodrigoprimo/WordPress-Coding-Standards/blob/694bdf514d518004cefc0a22923fedeb0091eaca/WordPress/Docs/WP/GetMetaSingleStandard.xml#L7

Here and in the other places where <![CDATA is used.

Copy link
Copy Markdown
Contributor Author

@tikifez tikifez Sep 17, 2024

Choose a reason for hiding this comment

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

Aligned items.

WordPress/Docs/PHP/PregQuoteDelimiterStandard.xml Outdated
Passing the $delimiter parameter to preg_quote() is strongly recommended to ensure the delimiter required by the PCRE functions are escaped.
]]>
</standard>

Copy link
Copy Markdown
Collaborator

@rodrigoprimo rodrigoprimo Sep 17, 2024

Choose a reason for hiding this comment

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

This newline is not necessary.

Copy link
Copy Markdown
Contributor Author

@tikifez tikifez Sep 17, 2024

Choose a reason for hiding this comment

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

Removed unnecessary newlines.

WordPress/Docs/PHP/PregQuoteDelimiterStandard.xml Outdated
>
<standard>
<![CDATA[
Passing the $delimiter parameter to preg_quote() is strongly recommended to ensure the delimiter required by the PCRE functions are escaped.
Copy link
Copy Markdown
Collaborator

@rodrigoprimo rodrigoprimo Sep 17, 2024

Choose a reason for hiding this comment

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

to ensure the delimiter required by the PCRE functions are escaped.

I haven't looked deeply into this so I might be missing something, but I'm not sure this is the reason to recommend that the $delimiter parameter is passed.

I got this from the issue where this sniff was introduced:

Verify that the optional second parameter $delimiter of preg_quote() is always passed.
Too often I come across code where it is missing and unless it is passed, the default / delimiters are presumed, which is often wrong.

Copy link
Copy Markdown
Contributor Author

@tikifez tikifez Sep 17, 2024

Choose a reason for hiding this comment

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

Updated the description and changed the example valid code to be one from WordPress core.

GaryJones
GaryJones requested changes Sep 25, 2024
View reviewed changes
WordPress/Docs/PHP/PregQuoteDelimiterStandard.xml
]]>
</code>
</code_comparison>
</documentation> No newline at end of file
Copy link
Copy Markdown
Member

@GaryJones GaryJones Sep 25, 2024

Choose a reason for hiding this comment

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

Add a clear line at the end of the file please.

WordPress/Docs/PHP/PregQuoteDelimiterStandard.xml
<code_comparison>
<code title="Valid: The delimiter is included.">
<![CDATA[
preg_quote( $dir, '#' )
Copy link
Copy Markdown
Member

@GaryJones GaryJones Sep 25, 2024

Choose a reason for hiding this comment

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

Suggested change
preg_quote( $dir, '#' )
preg_quote( $dir, <em>'#'</em> )

Use the <em>...</em> to highlight the focus of the code snippet.

@rodrigoprimo rodrigoprimo mentioned this pull request Sep 26, 2024
Open
@rodrigoprimo
Copy link
Copy Markdown
Collaborator

rodrigoprimo commented Feb 4, 2025

@tikifez, I was just wondering if you'll have a chance to finish this off in the near future. It would be great if this PR could be included in the next WPCS release.

If you haven't got time or lost interest, please let us know and we'll see if we can find someone to take over. Thanks!

@rodrigoprimo
Copy link
Copy Markdown
Collaborator

rodrigoprimo commented Jun 23, 2025

@tikifez, please let us know within a week if you are still interested in finishing this PR. If we don't hear back from you, we will presume you don't have time, and we will see if we can find someone else to take over and finish it. Thanks for your work so far!

@rodrigoprimo rodrigoprimo mentioned this pull request Dec 23, 2025
Merged
@jrfnl
Copy link
Copy Markdown
Member

jrfnl commented Dec 27, 2025

Closing as superseded by merged PR #2677

@jrfnl jrfnl closed this Dec 27, 2025
@jrfnl jrfnl added this to the 3.3.x milestone Jan 28, 2026
@jrfnl jrfnl modified the milestones: 3.3.x, 3.4.0 Feb 24, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@rodrigoprimo rodrigoprimo rodrigoprimo requested changes

@GaryJones GaryJones GaryJones requested changes

Assignees

No one assigned

Labels

Component: Extra Type: Documentation

Projects

None yet

Milestone

3.4.0

Development

Successfully merging this pull request may close these issues.

4 participants

@tikifez @rodrigoprimo @jrfnl @GaryJones