Changeset 37862

Timestamp:

06/26/2016 07:31:42 AM (9 years ago)

Author:

DrewAPicture

Message:

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

See #32246.

File:

• trunk/src/wp-includes/query.php (modified) (1 diff)

trunk/src/wp-includes/query.php

@@ -408 +408 @@
 
 /**
- * Is the query for the blog homepage?
- *
- * This is the page which shows the time based blog content of your site.
- *
- * Depends on the site's "Front page displays" Reading Settings 'show_on_front' and 'page_for_posts'.
- *
- * If you set a static page for the front page of your site, this function will return
- * true only on the page you set as the "Posts page".
+ * Determines if the query is for the blog homepage.
+ *
+ * The blog homepage is the page that shows the time-based blog content of the site.
+ *
+ * is_home() is dependent on the site's "Front page displays" Reading Settings 'show_on_front'
+ * and 'page_for_posts'.
+ *
+ * If a static page is set for the front page of the site, this function will return true only
+ * on the page you set as the "Posts page".
+ *
+ * @since 1.5.0
  *
  * @see is_front_page()
- *
- * @since 1.5.0
- *
  * @global WP_Query $wp_query Global WP_Query instance.
  *
- * @return bool True if blog view homepage.
+ * @return bool True if blog view homepage, otherwise false.
  */
 function is_home() {