set_post_format( int|object $post, string $format ): array|WP_Error|false
Assign a format to a post
Contents
Parameters
-
$postint|object Required -
The post for which to assign a format.
-
$formatstring Required -
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
File: wp-includes/post-formats.php.
View all references
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' );
}
Changelog
| Version | Description |
|---|---|
| 3.1.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
Basic Example