Changeset 16830

Timestamp:

12/09/2010 05:27:37 AM (14 years ago)

Author:

scribu

Message:

Clarify is_single() inline doc. Fixes #14034

File:

• trunk/wp-includes/query.php (modified) (5 diffs)

trunk/wp-includes/query.php

@@ -399 +399 @@
 
 /**
- * Is the query for a single Page?
+ * Is the query for a single page?
  *
  * If the $page parameter is specified, this function will additionally
- * check if the query is for one of the Pages specified.
+ * check if the query is for one of the pages specified.
  *
  * @see is_single()
  * @see is_singular()
  *
+ * @see WP_Query::is_page()
+ * @since 1.5.0
+ * @uses $wp_query
+ *
+ * @param mixed $page Page ID, title, slug, or array of such.
+ * @return bool
+ */
+function is_page( $page = '' ) {
+    global $wp_query;
+
+    return $wp_query->is_page( $page );
+}
+
+/**
+ * Is the query for paged result and not for the first page?
+ *
+ * @see WP_Query::is_paged()
+ * @since 1.5.0
+ * @uses $wp_query
+ *
+ * @return bool
+ */
+function is_paged() {
+    global $wp_query;
+
+    return $wp_query->is_paged();
+}
+
+/**
+ * Is the query for a post or page preview?
+ *
+ * @see WP_Query::is_preview()
+ * @since 2.0.0
+ * @uses $wp_query
+ *
+ * @return bool
+ */
+function is_preview() {
+    global $wp_query;
+
+    return $wp_query->is_preview();
+}
+
+/**
+ * Is the query for the robots file?
+ *
+ * @see WP_Query::is_robots()
+ * @since 2.1.0
+ * @uses $wp_query
+ *
+ * @return bool
+ */
+function is_robots() {
+    global $wp_query;
+
+    return $wp_query->is_robots();
+}
+
+/**
+ * Is the query for a search?
+ *
+ * @see WP_Query::is_search()
+ * @since 1.5.0
+ * @uses $wp_query
+ *
+ * @return bool
+ */
+function is_search() {
+    global $wp_query;
+
+    return $wp_query->is_search();
+}
+
+/**
+ * Is the query for a single post?
+ *
+ * Works for any post type, except attachments and pages
+ *
+ * If the $post parameter is specified, this function will additionally
+ * check if the query is for one of the Posts specified.
+ *
+ * @see is_page()
+ * @see is_singular()
+ *
  * @see WP_Query::is_single()
  * @since 1.5.0
  * @uses $wp_query
  *
- * @param mixed $page Page ID, title, slug, or array of Page IDs, titles, and slugs.
- * @return bool
- */
-function is_page( $page = '' ) {
-    global $wp_query;
-
-    return $wp_query->is_page( $page );
-}
-
-/**
- * Is the query for paged result and not for the first page?
- *
- * @see WP_Query::is_paged()
- * @since 1.5.0
- * @uses $wp_query
- *
- * @return bool
- */
-function is_paged() {
-    global $wp_query;
-
-    return $wp_query->is_paged();
-}
-
-/**
- * Is the query for a post or page preview?
- *
- * @see WP_Query::is_preview()
- * @since 2.0.0
- * @uses $wp_query
- *
- * @return bool
- */
-function is_preview() {
-    global $wp_query;
-
-    return $wp_query->is_preview();
-}
-
-/**
- * Is the query for the robots file?
- *
- * @see WP_Query::is_robots()
- * @since 2.1.0
- * @uses $wp_query
- *
- * @return bool
- */
-function is_robots() {
-    global $wp_query;
-
-    return $wp_query->is_robots();
-}
-
-/**
- * Is the query for a search?
- *
- * @see WP_Query::is_search()
- * @since 1.5.0
- * @uses $wp_query
- *
- * @return bool
- */
-function is_search() {
-    global $wp_query;
-
-    return $wp_query->is_search();
-}
-
-/**
- * Is the query for a single post?
- *
- * If the $post parameter is specified, this function will additionally
- * check if the query is for one of the Posts specified.
- *
- * Can also be used for attachments or any other post type except pages.
- *
- * @see is_page()
- * @see is_singular()
- *
- * @see WP_Query::is_single()
- * @since 1.5.0
- * @uses $wp_query
- *
- * @param mixed $post Post ID, title, slug, or array of Post IDs, titles, and slugs.
+ * @param mixed $post Post ID, title, slug, or array of such.
  * @return bool
  */
@@ -3025 +3025 @@
 
     /**
-     * Is the query for a single Page?
+     * Is the query for a single page?
      *
      * If the $page parameter is specified, this function will additionally
-     * check if the query is for one of the Pages specified.
+     * check if the query is for one of the pages specified.
      *
      * @see WP_Query::is_single()
@@ -3035 +3035 @@
      * @since 3.1.0
      *
-     * @param mixed $page Page ID, title, slug, or array of Page IDs, titles, and slugs.
+     * @param mixed $page Page ID, title, slug, or array of such.
      * @return bool
      */
@@ -3106 +3106 @@
      * Is the query for a single post?
      *
+     * Works for any post type, except attachments and pages
+     *
      * If the $post parameter is specified, this function will additionally
      * check if the query is for one of the Posts specified.
      *
-     * Can also be used for attachments or any other post type except pages.
-     *
      * @see WP_Query::is_page()
      * @see WP_Query::is_singular()
@@ -3116 +3116 @@
      * @since 3.1.0
      *
-     * @param mixed $post Post ID, title, slug, or array of Post IDs, titles, and slugs.
+     * @param mixed $post Post ID, title, slug, or array of such.
      * @return bool
      */