Changeset 32524

Timestamp:

05/21/2015 07:48:19 PM (10 years ago)

Author:

boonebgorges

Message:

Streamline support for multiple post types in get_posts_by_author_sql().

• Don't accept a comma-separated list, only a single post type or an array of post types. This is easier to document.
• Add changelog entries to all calling functions.

Props DrewAPicture.
Fixes #32243.

Location:

trunk

Files:

• src/wp-includes/post.php (modified) (3 diffs)
• src/wp-includes/user.php (modified) (2 diffs)
• tests/phpunit/tests/post/getPostsByAuthorSql.php (modified) (2 diffs)

trunk/src/wp-includes/post.php

@@ -5327 +5327 @@
  *
  * @since 2.2.0
- *
- * @param string|array $post_type Array or comma-separated string of post types.
- *                                Currently only supports 'post' or 'page'.
+ * @since 4.3.0 Added the ability to pass an array to `$post_type`.
+ *
+ * @param string|array $post_type Single post type or an array of post types. Currently only supports 'post' or 'page'.
  * @return string SQL code that can be added to a where clause.
  */
@@ -5340 +5340 @@
  *
  * @since 3.0.0
- * @since 4.3.0 Introduced the ability to pass multiple post types to `$post_type`.
+ * @since 4.3.0 Introduced the ability to pass an array of post types to `$post_type`.
  *
  * @see get_private_posts_cap_sql()
  *
- * @param array|string   $post_type   Array or comma-separated list of post type(s).
+ * @param array|string   $post_type   Single post type or an array of post types.
  * @param bool           $full        Optional. Returns a full WHERE statement instead of just
  *                                    an 'andalso' term. Default true.
@@ -5358 +5358 @@
         $post_types = $post_type;
     } else {
-        $post_types = preg_split( '/[\s,]+/', $post_type );
+        $post_types = array( $post_type );
     }
 

trunk/src/wp-includes/user.php

@@ -252 +252 @@
  * @since 3.0.0
  * @since 4.1.0 Added `$post_type` argument.
- * @since 4.3.0 Added `$public_only` argument.
+ * @since 4.3.0 Added `$public_only` argument. Added the ability to pass an array of post types to `$post_type`.
  *
  * @global wpdb $wpdb WordPress database object for queries.
@@ -289 +289 @@
  *
  * @param array        $users       Array of user IDs.
- * @param string|array $post_type   Optional. Array or comma-separated list of post types to check. Defaults to 'post'.
+ * @param string|array $post_type   Optional. Single post type or array of post types to check. Defaults to 'post'.
  * @param bool         $public_only Optional. Only return counts for public posts.  Defaults to false.
  * @return array Amount of posts each user has written.

trunk/tests/phpunit/tests/post/getPostsByAuthorSql.php

@@ -25 +25 @@
         register_post_type( 'bar' );
 
-        $maybe_string = get_posts_by_author_sql( 'foo,bar' );
+        $maybe_string = get_posts_by_author_sql( array( 'foo', 'bar' ) );
         $this->assertContains( "post_type = 'foo'", $maybe_string );
         $this->assertContains( "post_type = 'bar'", $maybe_string );
@@ -136 +136 @@
         wp_set_current_user( $u );
 
-        $maybe_string = get_posts_by_author_sql( 'foo,bar,baz' );
+        $maybe_string = get_posts_by_author_sql( array( 'foo', 'bar', 'baz' ) );
         $this->assertNotContains( "post_type = 'foo' AND ( post_status = 'publish' OR post_status = 'private' )", $maybe_string );
         $this->assertNotContains( "post_type = 'bar' AND ( post_status = 'publish' OR post_status = 'private' )", $maybe_string );