Question

set_post_format( int|object $post,  string $format )

Assign a format to a post

---

description

---

参数

$post

(int|object) (Required) The post for which to assign a format.

$format

(string) (Required) A format to assign. Use an empty string or array to remove all formats from the post.

---

返回值

(array|WP_Error|false) WP_Error on error. Array of affected term IDs on success.

---

源代码

File: wp-includes/post-formats.php

function set_post_format( $post, $format ) {
	$post = get_post( $post );

	if ( empty( $post ) )
		return new WP_Error( 'invalid_post', __( 'Invalid post.' ) );

	if ( ! empty( $format ) ) {
		$format = sanitize_key( $format );
		if ( 'standard' === $format || ! in_array( $format, get_post_format_slugs() ) )
			$format = '';
		else
			$format = 'post-format-' . $format;
	}

	return wp_set_post_terms( $post->ID, $format, 'post_format' );
}

---

更新日志

Version	description
3.1.0	Introduced.

---

相关函数

Uses

• wp-includes/l10n.php: __()
• wp-includes/formatting.php: sanitize_key()
• wp-includes/post.php: wp_set_post_terms()
• wp-includes/post.php: get_post()
• wp-includes/post-formats.php: get_post_format_slugs()
• wp-includes/class-wp-error.php: WP_Error::__construct()
Show 1 more use Hide more uses

---

Used By

• wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::create_item()
• wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::update_item()
• wp-admin/includes/class-wp-press-this.php: WP_Press_This::save_post()
• wp-admin/includes/post.php: edit_post()
• wp-admin/includes/post.php: bulk_edit_posts()
• wp-admin/includes/post.php: get_default_post_to_edit()
• wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_editPost()
• wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::mw_newPost()
• wp-includes/class-wp-xmlrpc-server.php: wp_xmlrpc_server::_insert_post()
Show 4 more used by Hide more used by

---

User Contributed Notes

1. 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 Codex

   Basic Example

   
   <?php
   /*
    * Set the post format of a post (in the loop).
    */
   
   set_post_format($post->ID, 'gallery' ); //sets the given post to the 'gallery' format
   
   ?>