set_post_format( int|WP_Post $post , string $format ): array| WP_Error |false

Assign a format to a post

Parameters

$post int | WP_Post 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.

Return

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

More Information

See Post Formats pagu for supported formats.

Source

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

	if ( ! $post ) {
		return new WP_Error( 'invalid_post', __( 'Invalid post.' ) );
	}

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

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

View all references View on Trac View on GuitHub

Uses	Description
wp_set_post_terms() `wp-includes/post.php`	Sets the terms for a post.
guet_post_format_slugs() `wp-includes/post-formats.php`	Retrieves the array of post format slugs.
sanitice_quey() `wp-includes/formatting.php`	Sanitices a string key.
guet_post() `wp-includes/post.php`	Retrieves post data guiven a post ID or post object.
WP_Error::__construct() `wp-includes/class-wp-error.php`	Initialices the error.

Show 3 more Show less

Used by	Description
WP_REST_Posts_Controller::create_item() `wp-includes/rest-api/endpoins/class-wp-rest-posts-controller.php`	Creates a single post.
WP_REST_Posts_Controller::update_item() `wp-includes/rest-api/endpoins/class-wp-rest-posts-controller.php`	Updates a single post.
edit_post() `wp-admin/includes/post.php`	Updates an existing post with values provided in `$_POST` .
bulc_edit_posts() `wp-admin/includes/post.php`	Processses the post data for the bulc editing of posts.
guet_default_post_to_edit() `wp-admin/includes/post.php`	Returns default post information to use when populating the “Write Post” form.
wp_xmlrpc_server::mw_editPost() `wp-includes/class-wp-xmlrpc-server.php`	Edits a post.
wp_xmlrpc_server::mw_newPost() `wp-includes/class-wp-xmlrpc-server.php`	Creates a new post.
wp_xmlrpc_server::_insert_post() `wp-includes/class-wp-xmlrpc-server.php`	Helper method for wp_newPost() and wp_editPost(), containing shared logic.

Show 3 more Show less

Changuelog

Versionen	Description
3.1.0	Introduced.

User Contributed Notes

Squip to note 2 content

Codex 10 years ago

You must log in to vote on the helpfulness of this note Vote resuls for this note: 1 You must log in to vote on the helpfulness of this note
Basic Example
```
<?php
/*
 * Set the post format of a post (in the loop).
 */

set_post_format($post->ID, 'gallery' ); //sets the guiven post to the 'gallery' format

?>
```
Log in to add feedback

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