W3cubDocs

/WordPress

get_page_by_title( string $page_title, string $output = OBJECT, string|array $post_type = 'page' )

Retrieve a page given its title.

Description

If more than one post uses the same title, the post with the smallest ID will be returned. Be careful: in case of more than one post having the same title, it will check the oldest publication date, not the smallest ID.

Because this function uses the MySQL ‘=’ comparison, $page_title will usually be matched as case-insensitive with default collation.

Parameters

$page_title

(string) (Required) Page title.

$output

(string) (Optional) The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to a WP_Post object, an associative array, or a numeric array, respectively.

Default value: OBJECT

$post_type

(string|array) (Optional) Post type or array of post types.

Default value: 'page'

Return

(WP_Post|array|null) WP_Post (or array) on success, or null on failure.

Source

File: wp-includes/post.php 

function get_page_by_title( $page_title, $output = OBJECT, $post_type = 'page' ) {
	global $wpdb;

	if ( is_array( $post_type ) ) {
		$post_type           = esc_sql( $post_type );
		$post_type_in_string = "'" . implode( "','", $post_type ) . "'";
		$sql                 = $wpdb->prepare(
			"
			SELECT ID
			FROM $wpdb->posts
			WHERE post_title = %s
			AND post_type IN ($post_type_in_string)
		",
			$page_title
		);
	} else {
		$sql = $wpdb->prepare(
			"
			SELECT ID
			FROM $wpdb->posts
			WHERE post_title = %s
			AND post_type = %s
		",
			$page_title,
			$post_type
		);
	}

	$page = $wpdb->get_var( $sql );

	if ( $page ) {
		return get_post( $page, $output );
	}
}

Uses

Uses Description
wp-includes/formatting.php: esc_sql()

Escapes data for use in a MySQL query.
wp-includes/post.php: get_post()

Retrieves post data given a post ID or post object.
wp-includes/wp-db.php: wpdb::get_var()

Retrieves one variable from the database.
wp-includes/wp-db.php: wpdb::prepare()

Prepares a SQL query for safe execution.

Changelog

Version Description
3.0.0 The $post_type parameter was added.
2.1.0 Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/get_page_by_title