set_post_format()

You are here:

set_post_format( int|object $poststring $format )

Assign a format to a post

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) Array of affected term IDs on success. WP_Error on error.


Top ↑

More Information More Information

See Post Formats page for supported formats.


Top ↑

Source Source

File: wp-includes/post-formats.php

70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
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' );
}


Top ↑

Changelog Changelog

Changelog
VersionDescription
3.1.0Introduced.
Was this article helpful?
Dislike 0
Views: 3

Cart

Log in

Create an Account
Back to Top