Directory

Documentation for `wp_title()` is busted · Issue #1463 · WordPress/Documentation-Issue-Tracker · GitHub
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.

Sign up for GitHub

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

Jump to bottom

Documentation for wp_title() is busted #1463

Open
crstauf opened this issue Feb 14, 2024 · 5 comments
Open

Documentation for wp_title() is busted #1463

crstauf opened this issue Feb 14, 2024 · 5 comments
Labels
self-assigned [Status] Review Issue in review

Comments

@crstauf
Copy link

crstauf commented Feb 14, 2024

Issue Description

The documentation for the wp_title() function is essentially empty.

URL of the Page with the Issue

https://developer.wordpress.org/reference/functions/wp_title/

Section of Page with the issue

All sections.

Why is this a problem?

Unhelpful.

Suggested Fix

Populate missing sections.
@crstauf crstauf added the [Status] To do Issue marked as Todo label Feb 14, 2024
@github-actions GitHub Actions
Copy link

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

@speedyprem
Copy link

/assign to me please

@github-actions GitHub Actions
Copy link

Hey @speedyprem, thanks for your interest in this issue! 🍪🍪🍪
If you have any questions, do not hesitate to ask them in our #docs Slack channel.
Enjoy and happy contributing ❤️

@speedyprem
Copy link

speedyprem commented Feb 27, 2024 •
edited

The wp_title() function is primarily used to get the title tag within the HTML section of a WordPress-powered website. This function dynamically generates the title based on various factors such as the page being viewed, the site name, and the configured settings.

Here's a basic example of how wp_title() might be used within a WordPress theme:

<head>
    <title><?php wp_title('|', true, 'right'); ?></title>
    <!-- Other meta tags, stylesheets, and scripts -->
</head>

In the above example, wp_title() is used to generate the content within the <title> tag. The function accepts parameters to specify the separator character ('|' in this case), whether to display the site name (true), and the position of the site name relative to the page title ('right').

@speedyprem
Copy link

This issue is ready for review.

/review

@github-actions github-actions bot added [Status] Review Issue in review and removed [Status] To do Issue marked as Todo labels Feb 27, 2024
@speedyprem speedyprem mentioned this issue Feb 27, 2024
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
self-assigned [Status] Review Issue in review
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@crstauf @speedyprem