[function] get_post

Browse: Home / Reference / Functions / get_post()

get_post( int|WP_Post|null $post = null, string $output = OBJECT, string $filter = 'raw' )

Retrieves post data given a post ID or post object.

CONTENTS

• Description
  • Parameters
  • Return
  • Source
  • Changelog
• Related
  • Uses
  • Used By
• User Contributed Notes

---

Description #Description

See sanitize_post() for optional $filter values. Also, the parameter $post, must be given as a variable, since it is passed by reference.

---

Parameters #Parameters

$post

(int|WP_Post|null) (Optional) Post ID or post object. Defaults to global $post.

Default value: null

$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

$filter

(string) (Optional) Type of filter to apply. Accepts 'raw', 'edit', 'db', or 'display'.

Default value: 'raw'

---

Top ↑

Return #Return

(WP_Post|array|null) Type corresponding to $output on success or null on failure. When $output is OBJECT, a WP_Postinstance is returned.

---

Top ↑

Source #Source

File: wp-includes/post.php

530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560

function get_post( $post = null, $output = OBJECT, $filter = 'raw' ) {     if ( empty( $post ) && isset( $GLOBALS['post'] ) )         $post = $GLOBALS['post'];       if ( $post instanceof WP_Post ) {         $_post = $post;     } elseif ( is_object( $post ) ) {         if ( empty( $post->filter ) ) {             $_post = sanitize_post( $post, 'raw' );             $_post = new WP_Post( $_post );         } elseif ( 'raw' == $post->filter ) {             $_post = new WP_Post( $post );         } else {             $_post = WP_Post::get_instance( $post->ID );         }     } else {         $_post = WP_Post::get_instance( $post );     }       if ( ! $_post )         return null;       $_post = $_post->filter( $filter );       if ( $output == ARRAY_A )         return $_post->to_array();     elseif ( $output == ARRAY_N )         return array_values( $_post->to_array() );       return $_post; }

Expand full source code View on Trac

---

Top ↑

Changelog #Changelog

Changelog

Version	Description
1.5.1	Introduced.

---

Top ↑

Related #Related

Top ↑

Uses #Uses

• wp-includes/class-wp-post.php: WP_Post::__construct()
• wp-includes/class-wp-post.php: WP_Post::get_instance()
• wp-includes/post.php: sanitize_post()

---

Top ↑

Used By #Used By

• wp-includes/class-wp-customize-manager.php: WP_Customize_Manager::trash_changeset_post()
• wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::check_template()
• wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php: WP_REST_Revisions_Controller::get_revision()
• wp-includes/rest-api/endpoints/class-wp-rest-revisions-controller.php: WP_REST_Revisions_Controller::get_parent()
• wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::get_post()
Show 294 more used by

---

Top ↑

User Contributed Notes #User Contributed Notes

1. Skip to note content

   You must log in to vote on the helpfulness of this noteVote results for this note:27You must log in to vote on the helpfulness of this note

   Contributed by Fiaz Husyn — 2 years ago

   For reference, WP_Post OBJECT contains following fields:

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27

   WP_Post Object (     [ID] =>     [post_author] =>     [post_date] =>     [post_date_gmt] =>     [post_content] =>     [post_title] =>     [post_excerpt] =>     [post_status] =>     [comment_status] =>     [ping_status] =>     [post_password] =>     [post_name] =>     [to_ping] =>     [pinged] =>     [post_modified] =>     [post_modified_gmt] =>     [post_content_filtered] =>     [post_parent] =>     [guid] =>     [menu_order] =>     [post_type] =>     [post_mime_type] =>     [comment_count] =>     [filter] => )

   Expand full source code

   Log in to add feedback
2. Skip to note content

   You must log in to vote on the helpfulness of this noteVote results for this note:7You must log in to vote on the helpfulness of this note

   Contributed by beachaney — 3 years ago

   Wouldn’t it be better practice to use get_the_title(..) in this case? directly accessing the post object’s data member would bypass applying filters and enforcing protected and private settings, unless that’s explicitly desired.

   Log in to add feedback
3. Skip to note content

   You must log in to vote on the helpfulness of this noteVote results for this note:6You must log in to vote on the helpfulness of this note

   Contributed by Codex — 3 years ago

   To get the title for a post with ID 7:

   1 2	$post_7 = get_post( 7 ); $title = $post_7->post_title;

   Alternatively, specify the $output parameter:

   1 2	$post_7 = get_post( 7, ARRAY_A ); $title = $post_7['post_title'];

   Log in to add feedback
4. Skip to note content

   You must log in to vote on the helpfulness of this noteVote results for this note:6You must log in to vote on the helpfulness of this note

   Contributed by rjksn — 2 years ago

   If you need special things—[shortcodes], paragraph tags, anything exciting—in the content, you should apply the filters as opposed to using do_shortcode().

   1 2	$post   = get_post( 42 ); $output =  apply_filters( 'the_content', $post->post_content );

   Log in to add feedback
5. Skip to note content

   You must log in to vote on the helpfulness of this noteVote results for this note:1You must log in to vote on the helpfulness of this note

   Contributed by Fiaz Husyn — 2 years ago

   For Reference : WP_Post Object has following properties, which are returned by get_post().

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19

   Member Variable Variable Type   Notes ID          int     The ID of the post post_author     string  The post author's user ID (numeric string) post_name   string  The post's slug post_type   string  See Post Types post_title  string  The title of the post post_date   string  Format: 0000-00-00 00:00:00 post_date_gmt   string  Format: 0000-00-00 00:00:00 post_content    string  The full content of the post post_excerpt    string  User-defined post excerpt post_status     string  See get_post_status for values comment_status  string  Returns: { open, closed } ping_status     string  Returns: { open, closed } post_password   string  Returns empty string if no password post_parent     int     Parent Post ID (default 0) post_modified   string  Format: 0000-00-00 00:00:00 post_modified_gmt   string  Format: 0000-00-00 00:00:00 comment_count   string  Number of comments on post (numeric string) menu_order  string  Order value as set through page-attribute when enabled (numeric string. Defaults to 0)

   Expand full source code

   Log in to add feedback
6. Skip to note content

   You must log in to vote on the helpfulness of this noteVote results for this note:1You must log in to vote on the helpfulness of this note

   Contributed by Al — 2 years ago

   If you have a shortcode in the content you should use:

   1 2	$post = get_post( 4304,ARRAY_A ); $output =  do_shortcode($post['post_content']);

   Log in to add feedback
7. Skip to note content

   You must log in to vote on the helpfulness of this noteVote results for this note:1You must log in to vote on the helpfulness of this note

   Contributed by ancawonka — 2 years ago

   If you want to get a post by slug, you could do a new WP_Query, or use the get_page_by_path function: https://developer.wordpress.org/reference/functions/get_page_by_path/

   You’ll need to use the post_type if you are not getting a page.

   Log in to add feedback
8. Skip to note content

   You must log in to vote on the helpfulness of this noteVote results for this note:0You must log in to vote on the helpfulness of this note

   Contributed by Riyaz — 3 years ago

   To Get author of the Post

   1 2	$post_info = get_post( 10 ); $author = $post_info->post_author;

   Log in to add feedback

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