云策 WordPress 开发者社区

类文档

WP_Customize_Header_Image_Setting

查看官方原文 ↗
💡 云策文档标注

概述

WP_Customize_Header_Image_Setting 是 WordPress 自定义器中的一个设置类，用于过滤值但不保存结果。开发者需通过其他设置或回调来处理结果。

关键要点

  • 继承自 WP_Customize_Setting，用于处理自定义器中的头部图像设置。
  • 设置 ID 为 'header_image_data'，用于唯一标识。
  • update 方法负责更新头部图像值，但不保存到数据库，需结合其他机制处理。
  • 当值为空时，会回退到 'header_image' 设置的值。
  • 支持数组或字符串值，通过 Custom_Image_Header 类设置头部图像。

代码示例

final class WP_Customize_Header_Image_Setting extends WP_Customize_Setting {
    public $id = 'header_image_data';
    public function update( $value ) {
        global $custom_image_header;
        if ( empty( $custom_image_header ) ) {
            require_once ABSPATH . 'wp-admin/includes/class-custom-image-header.php';
            $args = get_theme_support( 'custom-header' );
            $admin_head_callback = isset( $args[0]['admin-head-callback'] ) ? $args[0]['admin-head-callback'] : null;
            $admin_preview_callback = isset( $args[0]['admin-preview-callback'] ) ? $args[0]['admin-preview-callback'] : null;
            $custom_image_header = new Custom_Image_Header( $admin_head_callback, $admin_preview_callback );
        }
        if ( ! $value ) {
            $value = $this->manager->get_setting( 'header_image' )->post_value();
        }
        if ( is_array( $value ) && isset( $value['choice'] ) ) {
            $custom_image_header->set_header_image( $value['choice'] );
        } else {
            $custom_image_header->set_header_image( $value );
        }
    }
}

注意事项

  • 此类不保存结果，开发者需确保通过其他设置或回调来持久化处理。
  • 在非管理员环境下，可能需要初始化 Custom_Image_Header 对象。
  • 参考 WP_Customize_Setting 以了解更多自定义器设置的基础功能。
📄 原文内容

A setting that is used to filter a value, but will not save the results.

Description

Results should be properly handled using another setting or callback.

See also

Methods

Name Description
WP_Customize_Header_Image_Setting::update –

Source

final class WP_Customize_Header_Image_Setting extends WP_Customize_Setting {

	/**
	 * Unique string identifier for the setting.
	 *
	 * @since 3.4.0
	 * @var string
	 */
	public $id = 'header_image_data';

	/**
	 * @since 3.4.0
	 *
	 * @global Custom_Image_Header $custom_image_header
	 *
	 * @param mixed $value The value to update.
	 */
	public function update( $value ) {
		global $custom_image_header;

		// If _custom_header_background_just_in_time() fails to initialize $custom_image_header when not is_admin().
		if ( empty( $custom_image_header ) ) {
			require_once ABSPATH . 'wp-admin/includes/class-custom-image-header.php';
			$args                   = get_theme_support( 'custom-header' );
			$admin_head_callback    = isset( $args[0]['admin-head-callback'] ) ? $args[0]['admin-head-callback'] : null;
			$admin_preview_callback = isset( $args[0]['admin-preview-callback'] ) ? $args[0]['admin-preview-callback'] : null;
			$custom_image_header    = new Custom_Image_Header( $admin_head_callback, $admin_preview_callback );
		}

		/*
		 * If the value doesn't exist (removed or random),
		 * use the header_image value.
		 */
		if ( ! $value ) {
			$value = $this->manager->get_setting( 'header_image' )->post_value();
		}

		if ( is_array( $value ) && isset( $value['choice'] ) ) {
			$custom_image_header->set_header_image( $value['choice'] );
		} else {
			$custom_image_header->set_header_image( $value );
		}
	}
}

View all references View on Trac View on GitHub

Uses Description
WP_Customize_Settingwp-includes/class-wp-customize-setting.php

Changelog

Version Description
3.4.0 Introduced.