WordPress.org

Ready to get started?Download WordPress

Codex

Attention Interested in functions, hooks, classes, or methods? Check out the new WordPress Code Reference!

Function Reference/set post format

Contents

Description

Set the post format of a post. This can be called and used anywhere if a post Object and the format is provided.

Usage

<?php set_post_format$post $format); ?>

Parameters

$post
(int or object) (Required) ID of the post or Object of the post.
Default: none
$format
(string or array) (Required) The format of the post. Use an empty string or array to remove all formats from the post.
Default: none

Returns

Array (array) 
Array of affected term IDs. or mixed WP_Error if no or wrong post id or post object is passed.

Example

<?php
/*
 * Set the post format of a post (in the loop).
 */

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

?>

Changelog

Source File

set_post_format() is located in wp-includes/post-formats.php.

Related

Post Formats: set_post_format(), get_post_format(), has_post_format(), the_post_format_audio(), get_the_post_format_media(), get_content_audio(), the_post_format_chat(), get_the_post_format_chat(), get_content_chat(), add_chat_detection_format(), the_post_format_gallery(), get_content_galleries(), get_post_gallery_images(), the_post_format_image(), get_the_post_format_image(), get_content_images(), the_post_format_quote(), get_the_post_format_quote(), get_content_quote(), the_post_format_url(), get_the_post_format_url(), get_content_url(), the_post_format_video(), get_content_video(), the_remaining_content(), get_the_remaining_content(), get_post_format_meta(), post_format_content_class(), get_post_format_content_class(), post_formats_compat()

See also index of Function Reference and index of Template Tags.