WordPress.org

Make WordPress Core


Ignore:
Timestamp:
06/26/2016 07:31:42 AM (3 years ago)
Author:
DrewAPicture
Message:

Docs: Improve the syntax and tensing within the DocBlock for is_home().

See #32246.

File:
1 edited

Legend:

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

    r37848 r37862  
    408408
    409409/**
    410  * Is the query for the blog homepage?
    411  *
    412  * This is the page which shows the time based blog content of your site.
    413  *
    414  * Depends on the site's "Front page displays" Reading Settings 'show_on_front' and 'page_for_posts'.
    415  *
    416  * If you set a static page for the front page of your site, this function will return
    417  * true only on the page you set as the "Posts page".
     410 * Determines if the query is for the blog homepage.
     411 *
     412 * The blog homepage is the page that shows the time-based blog content of the site.
     413 *
     414 * is_home() is dependent on the site's "Front page displays" Reading Settings 'show_on_front'
     415 * and 'page_for_posts'.
     416 *
     417 * If a static page is set for the front page of the site, this function will return true only
     418 * on the page you set as the "Posts page".
     419 *
     420 * @since 1.5.0
    418421 *
    419422 * @see is_front_page()
    420  *
    421  * @since 1.5.0
    422  *
    423423 * @global WP_Query $wp_query Global WP_Query instance.
    424424 *
    425  * @return bool True if blog view homepage.
     425 * @return bool True if blog view homepage, otherwise false.
    426426 */
    427427function is_home() {
Note: See TracChangeset for help on using the changeset viewer.