get_page_by_title( string $page_title, string $output = OBJECT, string|array $post_type = 'page' ): WP_Post|array|null
- Since
- 2.1.0, 3.0.0
- Source
wp-includes/deprecated.php:4573
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.
Compatibility
Deprecated in WordPress 6.2.0. Use WP_Query.
- WordPress
- since 3.0.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$page_titlestring- Page title.
$outputstringoptional- 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 OBJECT.Default:
OBJECT $post_typestring|arrayoptional- Post type or array of post types. Default 'page'.Default:
'page'
Return value
WP_Post|array|null- WP_Post (or array) on success, or null on failure.
Performance profile
How much work a call to get_page_by_title() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Heavy
- Scaling
- Constant
- Instructions
- 27–40
- Plugin surface
- None
- Called by
- 0
Reaches the database via ->get_var().
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 51.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- querycontent query
get_post()called directly - sqldatabase query
->get_var()called directly - hookthird-party callbacks
do_action()one call below get_page_by_title()
Further down the call graph this can also reach option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.
What one call costs · 4 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost get_page_by_title() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
!is_array($post_type) | 27 | _deprecated_function(), ->prepare(), ->get_var() |
!is_array($post_type) | 31 | _deprecated_function(), ->prepare(), ->get_var(), get_post() |
is_array($post_type) | 36 | _deprecated_function(), esc_sql(), ->prepare(), ->get_var() |
is_array($post_type) | 40 | _deprecated_function(), esc_sql(), ->prepare(), ->get_var(), get_post() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 51 | 27–40 | 2 | |
| 8.5 | 51 | 27–40 | 2 | |
| 8.4 | 51 | 27–40 | 2 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 54 | 27–43 | 2 | |
| 8.2 | 54 | 27–43 | 2 | |
| 8.1 | 54 | 27–43 | 2 | |
| 7.4 | 54 | 27–43 | 2 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 3
- _deprecated_function()Marks a function as deprecated and inform when it has been used.
- esc_sql()Escapes data for use in a MySQL query.
- get_post()Retrieves post data given a post ID or post object.
Source code
function get_page_by_title( $page_title, $output = OBJECT, $post_type = 'page' ) { _deprecated_function( __FUNCTION__, '6.2.0', 'WP_Query' ); 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 ); } return null;}Changelog
Introduced in 2.1.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
$post_type parameter was added.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, from
src/wp-includes/deprecated.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.