Make WordPress Core


Ignore:
Timestamp:
02/13/2018 04:53:44 PM (7 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/taxonomy.php

    r42699 r42710  
    260260
    261261/**
    262  * Checks that the taxonomy name exists.
     262 * Determines whether the taxonomy name exists.
    263263 *
    264264 * Formerly is_taxonomy(), introduced in 2.3.0.
     265 *
     266 * For more information on this and similar theme functions, check out
     267 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
     268 * Conditional Tags} article in the Theme Developer Handbook.
    265269 *
    266270 * @since 3.0.0
     
    278282
    279283/**
    280  * Whether the taxonomy object is hierarchical.
     284 * Determines whether the taxonomy object is hierarchical.
    281285 *
    282286 * Checks to make sure that the taxonomy is an object first. Then Gets the
     
    284288 *
    285289 * A false return value might also mean that the taxonomy does not exist.
     290 *
     291 * For more information on this and similar theme functions, check out
     292 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
     293 * Conditional Tags} article in the Theme Developer Handbook.
    286294 *
    287295 * @since 2.3.0
     
    13161324
    13171325/**
    1318  * Check if Term exists.
     1326 * Determines whether a term exists.
    13191327 *
    13201328 * Formerly is_term(), introduced in 2.3.0.
     1329 *
     1330 * For more information on this and similar theme functions, check out
     1331 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
     1332 * Conditional Tags} article in the Theme Developer Handbook.
    13211333 *
    13221334 * @since 3.0.0
Note: See TracChangeset for help on using the changeset viewer.