set_post_format()

You are here:
In this article

set_post_format( int|object $post, string $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' );
}

Expand full source code View on Trac

Top ↑

Uses Uses

Uses
Uses Description
wp-includes/l10n.php: __()

Retrieve the translation of $text.
wp-includes/formatting.php: sanitize_key()

Sanitizes a string key.
wp-includes/post.php: wp_set_post_terms()

Set the terms for a post.
wp-includes/post.php: get_post()

Retrieves post data given a post ID or post object.
wp-includes/post-formats.php: get_post_format_slugs()

Retrieves the array of post format slugs.

Show 1 more use

Top ↑

Used By Used By

Used By
Used By Description
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::create_item()

Creates a single post.
wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php: WP_REST_Posts_Controller::update_item()

Updates a single post.
wp-admin/includes/post.php: edit_post()

Update an existing post with values provided in $_POST.
wp-admin/includes/post.php: bulk_edit_posts()

Process the post data for the bulk editing of posts.
wp-admin/includes/post.php: get_default_post_to_edit()

Default post information to use when populating the “Write Post” form.

Show 3 more used by

Top ↑

Changelog Changelog

Changelog
Version Description
3.1.0 Introduced.
Was this article helpful?
Dislike 0
Views: 11