wpseek.com
A WordPress-centric search engine for devs and theme authors



set_post_format › WordPress Function

Since3.1.0
Deprecatedn/a
› set_post_format ( $post, $format )
Parameters: (2)
  • (int|WP_Post) $post The post for which to assign a format.
    Required: Yes
  • (string) $format A format to assign. Use an empty string or array to remove all formats from the post.
    Required: Yes
Returns:
  • (array|WP_Error|false) Array of affected term IDs on success. WP_Error on error.
Defined at:
Codex:

Assign a format to a post



Related Functions: get_post_format, has_post_format, get_post_format_link, get_post_format_slugs, get_post_format_string

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