sergiotarxz/Wordpress
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

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

Browse Source 
See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@37862 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-06-26 07:31:42 +00:00
parent c97f234e6f
commit b36a6b44ed
1 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
src/wp-includes/query.php
View File

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