5 views 
Summery Summery
Assign a format to a post
Syntax Syntax
Parameters Parameters
- $post
-
(Required) The post for which to assign a format.
- $format
-
(Required) A format to assign. Use an empty string or array to remove all formats from the post.
Return Return
(array|WP_Error|false) WP_Error on error. Array of affected term IDs on success.
Source Source
File: wp-includes/post-formats.php
*/
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' );
Advertisement
Changelog Changelog
| Version | Description |
|---|---|
| 3.1.0 | Introduced. |