wp_prepare_site_data

函数
wp_prepare_site_data ( $data, $defaults, $old_site = null )
参数
  • (array) $data Associative array of site data passed to the respective function. See {@see} for the possibly included data.
    Required:
  • (array) $defaults Site data defaults to parse $data against.
    Required:
  • (WP_Site|null) $old_site Optional. Old site object if an update, or null if an insertion. Default null.
    Required:
    Default: null
返回值
  • (array|WP_Error) Site data ready for a database transaction, or WP_Error in case a validation error occurred.
定义位置
相关方法
wp_normalize_site_datawp_validate_site_datawp_create_tagwp_read_video_metadatawp_resolve_post_date
引入
5.1.0
弃用
-

wp_prepare_site_data: 这个过滤器用于准备网站数据,以便在JavaScript中使用。它被用来创建一个代表网站和其属性的JavaScript对象。

准备网站数据,以便在数据库中插入或更新。

function wp_prepare_site_data( $data, $defaults, $old_site = null ) {

	// Maintain backward-compatibility with `$site_id` as network ID.
	if ( isset( $data['site_id'] ) ) {
		if ( ! empty( $data['site_id'] ) && empty( $data['network_id'] ) ) {
			$data['network_id'] = $data['site_id'];
		}
		unset( $data['site_id'] );
	}

	/**
	 * Filters passed site data in order to normalize it.
	 *
	 * @since 5.1.0
	 *
	 * @param array $data Associative array of site data passed to the respective function.
	 *                    See {@see wp_insert_site()} for the possibly included data.
	 */
	$data = apply_filters( 'wp_normalize_site_data', $data );

	$allowed_data_fields = array( 'domain', 'path', 'network_id', 'registered', 'last_updated', 'public', 'archived', 'mature', 'spam', 'deleted', 'lang_id' );
	$data                = array_intersect_key( wp_parse_args( $data, $defaults ), array_flip( $allowed_data_fields ) );

	$errors = new WP_Error();

	/**
	 * Fires when data should be validated for a site prior to inserting or updating in the database.
	 *
	 * Plugins should amend the `$errors` object via its `WP_Error::add()` method.
	 *
	 * @since 5.1.0
	 *
	 * @param WP_Error     $errors   Error object to add validation errors to.
	 * @param array        $data     Associative array of complete site data. See {@see wp_insert_site()}
	 *                               for the included data.
	 * @param WP_Site|null $old_site The old site object if the data belongs to a site being updated,
	 *                               or null if it is a new site being inserted.
	 */
	do_action( 'wp_validate_site_data', $errors, $data, $old_site );

	if ( ! empty( $errors->errors ) ) {
		return $errors;
	}

	// Prepare for database.
	$data['site_id'] = $data['network_id'];
	unset( $data['network_id'] );

	return $data;
}

常见问题

FAQs
查看更多 >