get_default_post_to_edit( string $post_type = 'post', bool $create_in_db = false ): WP_Post

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$post_typestringoptional

A post type string. Default 'post'.Default: 'post'

$create_in_dbbooloptional

Whether to insert the post into database. Default false.Default: false

Return value

WP_Post

Post object containing all the default post data as attributes

Performance profile

How much work a call to get_default_post_to_edit() 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

Reaches the database via get_post().

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

69–125

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 179.

Plugin surface

3 hooks

Third-party callbacks on 'default_content', 'default_title', 'default_excerpt' run inside this call, and their cost is not bounded by anything here.

Called by

5

5 places in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_post()called directly
• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_get()one call below get_default_post_to_edit()
• serializeserialisationmaybe_unserialize()one call below get_default_post_to_edit()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 36 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_default_post_to_edit() can have, taken from its control-flow graph on PHP 8.5.

Hooks and filters fired · 3

3 hooks fire while get_default_post_to_edit() runs, in this order:

1. 1
   apply_filters( default_content )filterline 808 (+66 into the body)

   Filters the default post content initially used in the "Write Post" form.

2. 2
   apply_filters( default_title )filterline 818 (+76 into the body)

   Filters the default post title initially used in the "Write Post" form.

3. 3
   apply_filters( default_excerpt )filterline 828 (+86 into the body)

   Filters the default post excerpt initially used in the "Write Post" form.

Uses · 16

• esc_html()Escaping for HTML blocks.
• wp_unslash()Removes slashes from a string or recursively removes slashes from strings within an array.
• wp_insert_post()Inserts or update a post.
• __()Retrieves the translation of $text.
• get_post()Retrieves post data given a post ID or post object.
• current_theme_supports()Checks a theme's support for a given feature.
• post_type_supports()Checks a post type's support for a given feature.
• get_option()Retrieves an option value based on an option name.
• set_post_format()Assign a format to a post
• wp_after_insert_post()Fires actions after a post, its terms and meta data has been saved.
• wp_next_scheduled()Retrieves the next timestamp for an event.
• wp_schedule_event()Schedules a recurring event.

Used by · 5

• WP_Posts_List_Table::inline_edit()Outputs the hidden row displayed when inline editing
• get_default_page_to_edit()Gets the default page information to use.
• wp_dashboard_quick_press()Displays the Quick Draft widget.
• wp_xmlrpc_server::_insert_post()Helper method for wp_newPost() and wp_editPost(), containing shared logic.
• wp_xmlrpc_server::mw_newPost()Creates a new post.

Source code

View on Trac ↗View on GitHub ↗

742function get_default_post_to_edit( $post_type = 'post', $create_in_db = false ) {743	$post_title = '';744	if ( ! empty( $_REQUEST['post_title'] ) ) {745		$post_title = esc_html( wp_unslash( $_REQUEST['post_title'] ) );746	}747 748	$post_content = '';749	if ( ! empty( $_REQUEST['content'] ) ) {750		$post_content = esc_html( wp_unslash( $_REQUEST['content'] ) );751	}752 753	$post_excerpt = '';754	if ( ! empty( $_REQUEST['excerpt'] ) ) {755		$post_excerpt = esc_html( wp_unslash( $_REQUEST['excerpt'] ) );756	}757 758	if ( $create_in_db ) {759		$post_id = wp_insert_post(760			array(761				'post_title'  => __( 'Auto Draft' ),762				'post_type'   => $post_type,763				'post_status' => 'auto-draft',764			),765			false,766			false767		);768		$post    = get_post( $post_id );769		if ( current_theme_supports( 'post-formats' ) && post_type_supports( $post->post_type, 'post-formats' ) && get_option( 'default_post_format' ) ) {770			set_post_format( $post, get_option( 'default_post_format' ) );771		}772		wp_after_insert_post( $post, false, null );773 774		// Schedule auto-draft cleanup.775		if ( ! wp_next_scheduled( 'wp_scheduled_auto_draft_delete' ) ) {776			wp_schedule_event( time(), 'daily', 'wp_scheduled_auto_draft_delete' );777		}778	} else {779		$post                 = new stdClass();780		$post->ID             = 0;781		$post->post_author    = '';782		$post->post_date      = '';783		$post->post_date_gmt  = '';784		$post->post_password  = '';785		$post->post_name      = '';786		$post->post_type      = $post_type;787		$post->post_status    = 'draft';788		$post->to_ping        = '';789		$post->pinged         = '';790		$post->comment_status = get_default_comment_status( $post_type );791		$post->ping_status    = get_default_comment_status( $post_type, 'pingback' );792		$post->post_pingback  = get_option( 'default_pingback_flag' );793		$post->post_category  = get_option( 'default_category' );794		$post->page_template  = 'default';795		$post->post_parent    = 0;796		$post->menu_order     = 0;797		$post                 = new WP_Post( $post );798	}799 800	/**801	 * Filters the default post content initially used in the "Write Post" form.802	 *803	 * @since 1.5.0804	 *805	 * @param string  $post_content Default post content.806	 * @param WP_Post $post         Post object.807	 */808	$post->post_content = (string) apply_filters( 'default_content', $post_content, $post );809 810	/**811	 * Filters the default post title initially used in the "Write Post" form.812	 *813	 * @since 1.5.0814	 *815	 * @param string  $post_title Default post title.816	 * @param WP_Post $post       Post object.817	 */818	$post->post_title = (string) apply_filters( 'default_title', $post_title, $post );819 820	/**821	 * Filters the default post excerpt initially used in the "Write Post" form.

Changelog

Introduced in 2.0.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-admin/includes/post.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.