Make WordPress Core


Ignore:
Timestamp:
02/13/2018 04:53:44 PM (6 years ago)
Author:
DrewAPicture
Message:

Docs: Link to the "Conditional Tags" article in the Theme Developer Handbook from the descriptions for a variety of core conditional tag functions.

These notations largely serve to direct consumers (of both the source and the parsed code reference) to extended information on individual and related conditional tags throughout WordPress. The changeset also standardizes corresponding DocBlock summaries to use third-person singular verbs.

Notations been added for the following functions:

  • comments_open()
  • email exists()
  • has_excerpt()
  • has_post_thumbnail()
  • has_tag()
  • in_category()
  • in_the_loop()
  • is_404()
  • is_active_sidebar()
  • is_active_widget()
  • is_admin()
  • is_admin_bar_showing()
  • is_archive()
  • is_attachment()
  • is_author()
  • is_blog_installed()
  • is_category()
  • is_comments_popup()
  • is_date()
  • is_day()
  • is_dynamic_sidebar()
  • is_feed()
  • is_front_page()
  • is_home()
  • is_local_attachment()
  • is_main_query
  • is_month()
  • is_multi_author
  • is_new_day()
  • is_page()
  • is_page_template()
  • is_paged()
  • is_plugin_active()
  • is_plugin_active_for_network()
  • is_plugin_inactive()
  • is_plugin_page()
  • is_post_type_archive()
  • is_preview()
  • is_rtl()
  • is_search()
  • is_single()
  • is_singular()
  • is_sticky()
  • is_tag()
  • is_tax()
  • is_taxonomy_hierarchical()
  • is_time()
  • is_trackback()
  • is_user_logged_in()
  • is_year()
  • pings_open()
  • post_type_exists()
  • taxonomy_exists()
  • term_exists()
  • username exists()
  • wp_attachment_is_image()
  • wp_script_is()

Props janalwin.
Fixes #43254.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/category-template.php

    r42658 r42710  
    222222
    223223/**
    224  * Check if the current post is within any of the given categories.
     224 * Checks if the current post is within any of the given categories.
    225225 *
    226226 * The given categories are checked against the post's categories' term_ids, names and slugs.
     
    232232 * Prior to v2.7, this function could only be used in the WordPress Loop.
    233233 * As of 2.7, the function can be used anywhere if it is provided a post ID or post object.
     234 *
     235 * For more information on this and similar theme functions, check out
     236 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
     237 * Conditional Tags} article in the Theme Developer Handbook.
    234238 *
    235239 * @since 1.2.0
     
    14071411
    14081412/**
    1409  * Check if the current post has any of given tags.
     1413 * Checks if the current post has any of given tags.
    14101414 *
    14111415 * The given tags are checked against the post's tags' term_ids, names and slugs.
     
    14161420 * Prior to v2.7, this function could only be used in the WordPress Loop.
    14171421 * As of 2.7, the function can be used anywhere if it is provided a post ID or post object.
     1422 *
     1423 * For more information on this and similar theme functions, check out
     1424 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
     1425 * Conditional Tags} article in the Theme Developer Handbook.
    14181426 *
    14191427 * @since 2.6.0
Note: See TracChangeset for help on using the changeset viewer.