函数文档

wp_save_post_revision()

💡 云策文档标注

概述

wp_save_post_revision() 函数用于为文章创建修订版本,通常在文章更新后调用。它通过检查文章是否发生变化来决定是否保存修订,并管理修订数量限制。

关键要点

  • 函数接受文章ID作为参数,返回新修订ID或错误信息。
  • 在特定条件下(如自动保存、文章类型不支持修订、文章状态为自动草稿或修订功能未启用)会直接返回而不创建修订。
  • 通过比较当前文章与最新修订的字段变化来决定是否保存新修订,可使用过滤器覆盖此行为。
  • 保存修订后,会根据 wp_revisions_to_keep() 设置的保留数量删除旧修订。
  • 涉及多个相关函数和过滤器,如 wp_save_post_revision_check_for_changes 和 wp_save_post_revision_post_has_changed。

代码示例

function wp_save_post_revision( $post_id ) {
    if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) {
        return;
    }
    // 更多条件检查和逻辑...
    $return = _wp_put_post_revision( $post );
    // 管理修订数量...
    return $return;
}

注意事项

  • 避免在自动保存或特定钩子(如 post_updated)中重复调用,以防止冲突。
  • 使用过滤器可以自定义修订保存的逻辑,例如强制保存修订或添加额外变化检查。
  • 修订数量管理依赖于 wp_revisions_to_keep() 函数,需确保其正确配置。

📄 原文内容

Creates a revision for the current version of a post.

Description

Typically used immediately after a post update, as every update is a revision, and the most recent revision always matches the current post.

Parameters

$post_idintrequired
The ID of the post to save as a revision.

Return

int|WP_Error|void Void or 0 if error, new revision ID, if success.

Source

function wp_save_post_revision( $post_id ) {
	if ( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) {
		return;
	}

	// Prevent saving post revisions if revisions should be saved on wp_after_insert_post.
	if ( doing_action( 'post_updated' ) && has_action( 'wp_after_insert_post', 'wp_save_post_revision_on_insert' ) ) {
		return;
	}

	$post = get_post( $post_id );

	if ( ! $post ) {
		return;
	}

	if ( ! post_type_supports( $post->post_type, 'revisions' ) ) {
		return;
	}

	if ( 'auto-draft' === $post->post_status ) {
		return;
	}

	if ( ! wp_revisions_enabled( $post ) ) {
		return;
	}

	/*
	 * Compare the proposed update with the last stored revision verifying that
	 * they are different, unless a plugin tells us to always save regardless.
	 * If no previous revisions, save one.
	 */
	$revisions = wp_get_post_revisions( $post_id );
	if ( $revisions ) {
		// Grab the latest revision, but not an autosave.
		foreach ( $revisions as $revision ) {
			if ( str_contains( $revision->post_name, "{$revision->post_parent}-revision" ) ) {
				$latest_revision = $revision;
				break;
			}
		}

		/**
		 * Filters whether the post has changed since the latest revision.
		 *
		 * By default a revision is saved only if one of the revisioned fields has changed.
		 * This filter can override that so a revision is saved even if nothing has changed.
		 *
		 * @since 3.6.0
		 *
		 * @param bool    $check_for_changes Whether to check for changes before saving a new revision.
		 *                                   Default true.
		 * @param WP_Post $latest_revision   The latest revision post object.
		 * @param WP_Post $post              The post object.
		 */
		if ( isset( $latest_revision ) && apply_filters( 'wp_save_post_revision_check_for_changes', true, $latest_revision, $post ) ) {
			$post_has_changed = false;

			foreach ( array_keys( _wp_post_revision_fields( $post ) ) as $field ) {
				if ( normalize_whitespace( $post->$field ) !== normalize_whitespace( $latest_revision->$field ) ) {
					$post_has_changed = true;
					break;
				}
			}

			/**
			 * Filters whether a post has changed.
			 *
			 * By default a revision is saved only if one of the revisioned fields has changed.
			 * This filter allows for additional checks to determine if there were changes.
			 *
			 * @since 4.1.0
			 *
			 * @param bool    $post_has_changed Whether the post has changed.
			 * @param WP_Post $latest_revision  The latest revision post object.
			 * @param WP_Post $post             The post object.
			 */
			$post_has_changed = (bool) apply_filters( 'wp_save_post_revision_post_has_changed', $post_has_changed, $latest_revision, $post );

			// Don't save revision if post unchanged.
			if ( ! $post_has_changed ) {
				return;
			}
		}
	}

	$return = _wp_put_post_revision( $post );

	/*
	 * If a limit for the number of revisions to keep has been set,
	 * delete the oldest ones.
	 */
	$revisions_to_keep = wp_revisions_to_keep( $post );

	if ( $revisions_to_keep < 0 ) {
		return $return;
	}

	$revisions = wp_get_post_revisions( $post_id, array( 'order' => 'ASC' ) );

	/**
	 * Filters the revisions to be considered for deletion.
	 *
	 * @since 6.2.0
	 *
	 * @param WP_Post[] $revisions Array of revisions, or an empty array if none.
	 * @param int       $post_id   The ID of the post to save as a revision.
	 */
	$revisions = apply_filters(
		'wp_save_post_revision_revisions_before_deletion',
		$revisions,
		$post_id
	);

	$delete = count( $revisions ) - $revisions_to_keep;

	if ( $delete < 1 ) {
		return $return;
	}

	$revisions = array_slice( $revisions, 0, $delete );

	for ( $i = 0; isset( $revisions[ $i ] ); $i++ ) {
		if ( str_contains( $revisions[ $i ]->post_name, 'autosave' ) ) {
			continue;
		}

		wp_delete_post_revision( $revisions[ $i ]->ID );
	}

	return $return;
}

Hooks

apply_filters( ‘wp_save_post_revision_check_for_changes’, bool $check_for_changes, WP_Post $latest_revision, WP_Post $post )

Filters whether the post has changed since the latest revision.

apply_filters( ‘wp_save_post_revision_post_has_changed’, bool $post_has_changed, WP_Post $latest_revision, WP_Post $post )

Filters whether a post has changed.

apply_filters( ‘wp_save_post_revision_revisions_before_deletion’, WP_Post[] $revisions, int $post_id )

Filters the revisions to be considered for deletion.

Changelog

Version Description
2.6.0 Introduced.