Changeset 34502

Timestamp:

09/24/2015 04:17:23 PM (9 years ago)

Author:

DrewAPicture

Message:

Docs: Add more explicit optional parameter types and return descriptions in the DocBlocks for is_page(), is_single(), is_singular().

Also adds explicit types and return descriptions to the corresponding WP_Query methods: WP_Query::is_page(), WP_Query::is_single(), and WP_Query::is_singular().

Props Shelob9 for the initial patch.
Fixes #33907.

File:

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

trunk/src/wp-includes/query.php

@@ -489 +489 @@
  * @global WP_Query $wp_query Global WP_Query instance.
  *
- * @param mixed $page Page ID, title, slug, or array of such.
- * @return bool
+ * @param int|string|array $page Optional. Page ID, title, slug, or array of such. Default empty.
+ * @return bool Whether the query is for an existing single page.
  */
 function is_page( $page = '' ) {
@@ -598 +598 @@
  * @global WP_Query $wp_query Global WP_Query instance.
  *
- * @param mixed $post Post ID, title, slug, or array of such.
- * @return bool
+ * @param int|string|array $post Optional. Post ID, title, slug, or array of such. Default empty.
+ * @return bool Whether the query is for an existing single post.
  */
 function is_single( $post = '' ) {
@@ -625 +625 @@
  * @global WP_Query $wp_query Global WP_Query instance.
  *
- * @param mixed $post_types Optional. Post Type or array of Post Types
- * @return bool
+ * @param string|array $post_types Optional. Post type or array of post types. Default empty.
+ * @return bool Whether the query is for an existing single post of any of the given post types.
  */
 function is_singular( $post_types = '' ) {
@@ -4407 +4407 @@
      * @since 3.1.0
      *
-     * @param mixed $page Page ID, title, slug, path, or array of such.
-     * @return bool
+     * @param int|string|array $page Optional. Page ID, title, slug, path, or array of such. Default empty.
+     * @return bool Whether the query is for an existing single page.
      */
     public function is_page( $page = '' ) {
@@ -4500 +4500 @@
      * @since 3.1.0
      *
-     * @param mixed $post Post ID, title, slug, path, or array of such.
-     * @return bool
+     * @param int|string|array $post Optional. Post ID, title, slug, path, or array of such. Default empty.
+     * @return bool Whether the query is for an existing single post.
      */
     public function is_single( $post = '' ) {
@@ -4546 +4546 @@
      * @since 3.1.0
      *
-     * @param mixed $post_types Optional. Post Type or array of Post Types
-     * @return bool
+     * @param string|array $post_types Optional. Post type or array of post types. Default empty.
+     * @return bool Whether the query is for an existing single post of any of the given post types.
      */
     public function is_singular( $post_types = '' ) {