Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Special Strings in the "new_admin_email_content" filter documentation are incorrect #1208

Closed
shawnhooper opened this issue Oct 19, 2023 · 5 comments
Assignees
Labels
code reference Issues for Code Reference portal of DevHub developer documentation (DevHub) Improvements or additions to developer documentation [Status] Done Issue is completed

Comments

@shawnhooper
Copy link
Contributor

shawnhooper commented Oct 19, 2023

Issue Description

Special Strings in the "new_admin_email_content" filter documentation are incorrect. They are missing the leading ### characters.

URL of the Page with the Issue

https://developer.wordpress.org/reference/hooks/new_admin_email_content/

Section of Page with the issue

Description

Why is this a problem?

Using the names specified in the documentation will result in the strings not being properly replaced when the new admin notification email is sent.

Suggested Fix

  • USERNAME### should be changed to ###USERNAME###
  • ADMIN_URL### should be changed to ###ADMIN_URL###
  • EMAIL### should be changed to ###EMAIL###
  • SITENAME### should be changed to ###SITENAME###
  • SITEURL### should be changed to ###SITEURL###
@shawnhooper shawnhooper added the [Status] To do Issue marked as Todo label Oct 19, 2023
@github-actions
Copy link

Heads up @WordPress/docs-issues-coordinators, we have a new issue open. Time to use 'em labels.

@shawnhooper
Copy link
Contributor Author

It looks like this may be an issue with the Parser. The variables are correct in core, but are not being rendered correctly in the docs.

Filter Documentation

image

Comments in Core

image

@zzap zzap added the code reference Issues for Code Reference portal of DevHub label Oct 23, 2023
@github-actions github-actions bot added the developer documentation (DevHub) Improvements or additions to developer documentation label Oct 23, 2023
@github-actions
Copy link

Heads up @stevenlinx - the "code reference" label was applied to this issue.

@stevenlinx
Copy link
Member

stevenlinx commented Oct 23, 2023

Hello, thanks for filing.

Yes, this has to do with the Parser and is not something that can be edited on DevHub.

If you're on WP.org Slack, I would advise you to ask about it on Core channel.

Alternatively, you may file a ticket on Core Trac.
https://core.trac.wordpress.org/newticket

@dd32 dd32 closed this as completed Jan 16, 2024
@github-actions github-actions bot added [Status] Done Issue is completed and removed [Status] In progress Issue is in progress labels Jan 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code reference Issues for Code Reference portal of DevHub developer documentation (DevHub) Improvements or additions to developer documentation [Status] Done Issue is completed
4 participants