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

Assign a format to a post


Description Description


Parameters Parameters

$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.


Top ↑

Return Return

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


Top ↑

Source Source

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' );
}

Top ↑

Changelog Changelog

Changelog
Version Description
3.1.0 Introduced.


Top ↑

User Contributed Notes User Contributed Notes

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