Obsolete content Edit

Topics

Highlight: Use a warning notice type to mark content as outdated.

As WordPress develops and evolves systematically, some methods and technologies change, which may outdate documentation. Accurately identifying and marking outdated content is beneficial for updating and maintaining up-to-date documentation for readers.

Types of obsolete content

Obsolete content can be determined by the following contexts:

  • A whole page or article is outdated.
  • A section from a page or article is outdated.
  • A specific part of a section, page, or article is outdated.

Top ↑

Marking content as obsolete

Top ↑

Outdated page

Use a Warning notice type to mark a page as obsolete, by enclosing the following phrase inside the

Topics

short code:
Warning: This page is outdated as of WordPress VERSION. It is maintained for archival purposes only.

Replace VERSION with the WordPress version since the page was marked obsolete.

Example

Recommended (Markdown):
**Warning:** This page is outdated as of WordPress 5.5.2. It is maintained for archival purposes only.

Top ↑

Outdated section from a page or article

Use a Warning notice type to mark a section from a page as obsolete, by enclosing the following phrase inside the

Topics

short code:
Warning: The SECTION_NAME section is outdated as of WordPress VERSION. It is maintained for archival purposes only.

Replace SECTION_NAME with the title, heading, subheading, or description of the outdated section. Replace VERSION with the WordPress version since the page was marked obsolete.

Example

Recommended (Markdown):
**Warning:** The *Installation* section is outdated as of WordPress 4.3. It is maintained for archival purposes only.

Top ↑

Outdated part of a section, page, or article

Use a Warning notice type to mark specific content of a section as obsolete, by enclosing the following phrase inside the

Topics

short code:
Warning: The following content on SECTION_NAME is outdated as of WordPress VERSION. It is maintained for archival purposes only.

Replace SECTION_NAME with the title, heading, subheading, or description of the outdated part. Replace VERSION with the WordPress version since the page was marked obsolete.

Example

Recommended (Markdown):
**Warning:** The following content on *i18n in JavaScriptJavaScript JavaScript or JS is an object-oriented computer programming language commonly used to create interactive effects within web browsers. WordPress makes extensive use of JS for a better user experience. While PHP is executed on the server, JS executes within a user’s browser. https://www.javascript.com/.* is outdated as of WordPress 5.0. It is maintained for archival purposes only.

Top ↑

Adding updated documentation

Use an Info notice type and add a URL of updated documentation, if any.

  • If the updated information can be found on another page, enclose the following notice inside the

    Topics

     short code:

Note: Updated information can be found on PAGE_URL.
Replace PAGE_URL with the URL of the updated documentation.

  • If the page was moved to another destination, enclose the following notice inside the

    Topics

     short code:

Note: This page was moved to PAGE_URL.
Replace PAGE_URL with the URL of the new destination.

Examples

Recommended (Markdown):
**Warning:** The following content on *i18n in JavaScriptJavaScript JavaScript or JS is an object-oriented computer programming language commonly used to create interactive effects within web browsers. WordPress makes extensive use of JS for a better user experience. While PHP is executed on the server, JS executes within a user’s browser. https://www.javascript.com/.* is outdated as of WordPress 5.0. It is maintained for archival purposes only.

**Note:** Updated information can be found on https://developer.wordpress.org/block-editor/developers/internationalization/#how-to-use-i18n-in-javascript.

Recommended (Markdown):
**Warning:** This page is outdated as of WordPress 5.5.2. It is maintained for archival purposes only.

**Note:** This page was moved to https://developer.wordpress.org/reference.

Last updated: