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

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

Changelog