set_post_format

函数
set_post_format ( $post, $format )
参数
  • (int|object) $post The post for which to assign a format.
    Required:
  • (string) $format A format to assign. Use an empty string or array to remove all formats from the post.
    Required:
返回值
  • (array|WP_Error|false) Array of affected term IDs on success. WP_Error on error.
定义位置
相关方法
get_post_formathas_post_formatget_post_format_linkget_post_format_slugsget_post_format_string
引入
3.1.0
弃用
-

set_post_format: 这是一个WordPress的函数,为当前的文章设置文章格式。它通常在文章编辑器中用来选择文章的格式,如视频或音频: 这个函数需要一个参数,就是要设置的文章格式。

为一个文章指定一个格式。

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' );
}

常见问题

FAQs
查看更多 >