get_posts_by_author_sql( array|string $post_type, bool $full = true, int $post_author = null, bool $public_only = false )

Retrieve the post SQL based on capability, author, and type.


Description Description


Parameters Parameters

$post_type

(array|string) (Required) Single post type or an array of post types.

$full

(bool) (Optional) Returns a full WHERE statement instead of just an 'andalso' term.

Default value: true

$post_author

(int) (Optional) Query posts having a single author ID.

Default value: null

$public_only

(bool) (Optional) Only return public posts. Skips cap checks for $current_user.

Default value: false


Top ↑

Return Return

(string) SQL WHERE code that can be added to a query.


Top ↑

Source Source

File: wp-includes/post.php

function get_posts_by_author_sql( $post_type, $full = true, $post_author = null, $public_only = false ) {
	global $wpdb;

	if ( is_array( $post_type ) ) {
		$post_types = $post_type;
	} else {
		$post_types = array( $post_type );
	}

	$post_type_clauses = array();
	foreach ( $post_types as $post_type ) {
		$post_type_obj = get_post_type_object( $post_type );
		if ( ! $post_type_obj ) {
			continue;
		}

		/**
		 * Filters the capability to read private posts for a custom post type
		 * when generating SQL for getting posts by author.
		 *
		 * @since 2.2.0
		 * @deprecated 3.2.0 The hook transitioned from "somewhat useless" to "totally useless".
		 *
		 * @param string $cap Capability.
		 */
		if ( ! $cap = apply_filters( 'pub_priv_sql_capability', '' ) ) {
			$cap = current_user_can( $post_type_obj->cap->read_private_posts );
		}

		// Only need to check the cap if $public_only is false.
		$post_status_sql = "post_status = 'publish'";
		if ( false === $public_only ) {
			if ( $cap ) {
				// Does the user have the capability to view private posts? Guess so.
				$post_status_sql .= " OR post_status = 'private'";
			} elseif ( is_user_logged_in() ) {
				// Users can view their own private posts.
				$id = get_current_user_id();
				if ( null === $post_author || ! $full ) {
					$post_status_sql .= " OR post_status = 'private' AND post_author = $id";
				} elseif ( $id == (int) $post_author ) {
					$post_status_sql .= " OR post_status = 'private'";
				} // else none
			} // else none
		}

		$post_type_clauses[] = "( post_type = '" . $post_type . "' AND ( $post_status_sql ) )";
	}

	if ( empty( $post_type_clauses ) ) {
		return $full ? 'WHERE 1 = 0' : '1 = 0';
	}

	$sql = '( '. implode( ' OR ', $post_type_clauses ) . ' )';

	if ( null !== $post_author ) {
		$sql .= $wpdb->prepare( ' AND post_author = %d', $post_author );
	}

	if ( $full ) {
		$sql = 'WHERE ' . $sql;
	}

	return $sql;
}

Top ↑

Changelog Changelog

Changelog
Version Description
4.3.0 Introduced the ability to pass an array of post types to $post_type.
3.0.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

  1. Skip to note content
    Contributed by Codex

    Example

    $where = get_posts_by_author_sql( 'post' );
    echo $where;
    
    // user logged in: WHERE post_type = 'post' AND (post_status = 'publish' OR post_status = 'private')
    // user not logged in: WHERE post_type = 'post' AND (post_status = 'publish')
    
    // get post ID with title "Hello world!" query
    global $wpdb;
    $query = "SELECT ID FROM $wpdb->posts $where AND post_title = %s";
    $post_id = $wpdb->get_var( $wpdb->prepare( $query, 'Hello world!' ) );
    

You must log in before being able to contribute a note or feedback.