WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

set_post_format()

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

In this article

Back to top

Assign a format to a post

Parameters

$postint|WP_Postrequired
The post for which to assign a format.
$formatstringrequired
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 page for supported formats.

Source

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

	if ( ! $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(), 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 GitHub

UsesDescription
wp_set_post_terms()wp-includes/post.php

Sets the terms for a post.

get_post_format_slugs()wp-includes/post-formats.php

Retrieves the array of post format slugs.

__()wp-includes/l10n.php

Retrieves the translation of $text.

sanitize_key()wp-includes/formatting.php

Sanitizes a string key.

get_post()wp-includes/post.php

Retrieves post data given a post ID or post object.

WP_Error::__construct()wp-includes/class-wp-error.php

Initializes the error.

Show 4 moreShow less
Used byDescription
WP_REST_Posts_Controller::create_item()wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Creates a single post.

WP_REST_Posts_Controller::update_item()wp-includes/rest-api/endpoints/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.

bulk_edit_posts()wp-admin/includes/post.php

Processes the post data for the bulk editing of posts.

get_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 moreShow less

Changelog

VersionDescription
3.1.0Introduced.

User Contributed Notes

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