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/widgets.php

    r42374 r42710  
    802802
    803803/**
    804  * Whether widget is displayed on the front end.
     804 * Determines whether a given widget is displayed on the front end.
    805805 *
    806806 * Either $callback or $id_base can be used
     
    813813 * NOTE: $widget_id and $id_base are the same for single widgets. To be effective
    814814 * this function has to run after widgets have initialized, at action {@see 'init'} or later.
    815  *
     815 *
     816 * For more information on this and similar theme functions, check out
     817 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
     818 * Conditional Tags} article in the Theme Developer Handbook.
     819 *
    816820 * @since 2.2.0
    817821 *
     
    850854
    851855/**
    852  * Whether the dynamic sidebar is enabled and used by theme.
    853  *
     856 * Determines whether the dynamic sidebar is enabled and used by the theme.
     857 *
     858 * For more information on this and similar theme functions, check out
     859 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
     860 * Conditional Tags} article in the Theme Developer Handbook.
     861 *
    854862 * @since 2.2.0
    855863 *
     
    875883
    876884/**
    877  * Whether a sidebar is in use.
    878  *
     885 * Determines whether a sidebar is in use.
     886 *
     887 * For more information on this and similar theme functions, check out
     888 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
     889 * Conditional Tags} article in the Theme Developer Handbook.
     890 *
    879891 * @since 2.8.0
    880892 *
Note: See TracChangeset for help on using the changeset viewer.