WordPress函数：add_option 添加配置项

函数原型：

add_option( string $option, mixed $value = '', string $deprecated = '', string|bool $autoload = 'yes' ): bool

添加一个新选项。

您不需要序列化值。如果该值需要序列化，则在将其插入数据库之前将对其进行序列化。

请记住，资源不能作为选项进行序列化或添加。

您可以创建不带值的选项，然后稍后更新值。

现有的选项将不会更新，并进行检查以确保您没有添加受保护的WordPress选项。应注意不要将选项命名为与受保护选项相同的选项。

参数说明：

$option，要添加的选项的名称。应为非SQL转义。

$value，期权价值。如果不是标量，则必须是可序列化的。应为非SQL转义。

$deprecated，标记已过时，此选项不再用了。

$autoload，是否在WordPress启动时加载该选项。默认值已启用。由于遗留原因，接受要禁用的“否”。

函数源码：

function add_option( $option, $value = '', $deprecated = '', $autoload = 'yes' ) {
	global $wpdb;

	if ( ! empty( $deprecated ) ) {
		_deprecated_argument( __FUNCTION__, '2.3.0' );
	}

	if ( is_scalar( $option ) ) {
		$option = trim( $option );
	}

	if ( empty( $option ) ) {
		return false;
	}

	$deprecated_keys = array(
		'blacklist_keys'    => 'disallowed_keys',
		'comment_whitelist' => 'comment_previously_approved',
	);

	if ( isset( $deprecated_keys[ $option ] ) && ! wp_installing() ) {
		_deprecated_argument(
			__FUNCTION__,
			'5.5.0',
			sprintf(
				/* translators: 1: Deprecated option key, 2: New option key. */
				__( 'The "%1$s" option key has been renamed to "%2$s".' ),
				$option,
				$deprecated_keys[ $option ]
			)
		);
		return add_option( $deprecated_keys[ $option ], $value, $deprecated, $autoload );
	}

	wp_protect_special_option( $option );

	if ( is_object( $value ) ) {
		$value = clone $value;
	}

	$value = sanitize_option( $option, $value );

	$notoptions = wp_cache_get( 'notoptions', 'options' );

	if ( ! is_array( $notoptions ) || ! isset( $notoptions[ $option ] ) ) {
		/** This filter is documented in wp-includes/option.php */
		if ( apply_filters( "default_option_{$option}", false, $option, false ) !== get_option( $option ) ) {
			return false;
		}
	}

	$serialized_value = maybe_serialize( $value );
	$autoload         = ( 'no' === $autoload || false === $autoload ) ? 'no' : 'yes';

	do_action( 'add_option', $option, $value );

	$result = $wpdb->query( $wpdb->prepare( "INSERT INTO `$wpdb->options` (`option_name`, `option_value`, `autoload`) VALUES (%s, %s, %s) ON DUPLICATE KEY UPDATE `option_name` = VALUES(`option_name`), `option_value` = VALUES(`option_value`), `autoload` = VALUES(`autoload`)", $option, $serialized_value, $autoload ) );
	if ( ! $result ) {
		return false;
	}

	if ( ! wp_installing() ) {
		if ( 'yes' === $autoload ) {
			$alloptions            = wp_load_alloptions( true );
			$alloptions[ $option ] = $serialized_value;
			wp_cache_set( 'alloptions', $alloptions, 'options' );
		} else {
			wp_cache_set( $option, $serialized_value, 'options' );
		}
	}

	// This option exists now.
	$notoptions = wp_cache_get( 'notoptions', 'options' ); // Yes, again... we need it to be fresh.

	if ( is_array( $notoptions ) && isset( $notoptions[ $option ] ) ) {
		unset( $notoptions[ $option ] );
		wp_cache_set( 'notoptions', $notoptions, 'options' );
	}

	do_action( "add_option_{$option}", $option, $value );

	do_action( 'added_option', $option, $value );

	return true;
}

包含钩子：

do_action( 'added_option', string $option, mixed $value )

do_action( 'add_option', string $option, mixed $value )

do_action( "add_option_{$option}", string $option, mixed $value )

apply_filters( "default_option_{$option}", mixed $default_value, string $option, bool $passed_default )

使用举例：

add_option( 'myhack_extraction_length', '255', '', 'yes' );

WordPress 主题 和 WordPress 插件的配置项，不管多复杂，最终都是要使用这个函数：add_option。