felixarntz / wp-global-options
实现了WordPress的全局选项存储。
1.0.0-beta.1
2018-02-21 18:41 UTC
Requires
- composer/installers: ~1.0
Requires (Dev)
- phpunit/phpunit: ^6
This package is auto-updated.
Last update: 2024-09-06 09:32:58 UTC
README
WP Global Options
实现了WordPress的全局选项存储。
它做什么
- 引入了一个名为
global_options
的数据库表 - 引入了全局选项的CRUD API,包括净化和验证
- 引入了全局瞬时的CRUD API
- 引入了注册/注销全局设置的API
- 包括一个用于WP-CLI的
wp global-options
命令
如何安装
该插件可以作为网络范围的常规插件或作为必需的插件安装。
建议
- 尽管为插件函数和类名添加前缀是一种最佳实践,但此插件是WordPress核心的证明概念,最终可能将多个函数放入其中。此插件仅对特定于插件的函数和类名进行前缀处理,对自己内部的辅助函数或钩子。未添加前缀的函数和类被条件包装,以便如果WordPress核心采用它们,则将加载其核心版本。因此,不要定义以下任何函数或类:
sanitize_global_option()
get_global_option()
update_global_option()
add_global_option()
delete_global_option()
wp_load_global_alloptions()
get_global_transient()
set_global_transient()
delete_global_transient()
register_global_setting()
unregister_global_setting()
get_registered_global_settings()
filter_default_global_option()
使用方法
管理全局选项
- 函数:
get_global_option( string $option, mixed $default = false ): mixed
- 函数:
update_global_option( string $option, mixed $value, string|bool $autoload = null ): bool
- 函数:
add_global_option( string $option, mixed $value, string|bool $autoload = 'no' ): bool
- 函数:
delete_global_option( string $option ): bool
管理全局瞬时
- 函数:
get_global_transient( string $transient ): mixed
- 函数:
set_global_transient( string $transient, mixed $value, int $expiration = 0 ): bool
- 函数:
delete_global_transient( string $transient ): bool
管理全局设置
- 函数:
register_global_setting( string $option_group, string $option_name, array $args = array() )
- 函数:
unregister_global_setting( string $option_group, string $option_name )
- 函数:
get_registered_global_settings()
钩子
- 过滤器:
sanitize_global_option_{$option}
- 过滤器:
validate_global_option_{$option}
- 过滤器:
pre_global_option_{$option}
- 过滤器:
default_global_option_{$option}
- 过滤器:
global_option_{$option}
- 过滤器:
pre_update_global_option_{$option}
- 过滤器:
pre_update_global_option
- 过滤器:
pre_global_transient_{$transient}
- 过滤器:
global_transient_{$transient}
- 过滤器:
pre_set_global_transient_{$transient}
- 过滤器:
expiration_of_global_transient_{$transient}
- 动作:
update_global_option
- 动作:
update_global_option_{$option}
- 动作:
updated_global_option
- 动作:
add_global_option
- 动作:
add_global_option_{$option}
- 动作:
added_global_option
- 动作:
pre_delete_global_option_{$option}
- 动作:
delete_global_option_{$option}
- 动作:
deleted_global_option
- 动作:
set_global_transient_{$transient}
- 动作:
setted_global_transient
- 动作:
delete_global_transient_{$transient}
- 动作:
deleted_global_transient