Inline documentation for hooks in wp-includes/option.php.
Props siobhyb for the initial patch. Props DrewAPicture, kpdesign. Fixes #25905. Built from https://develop.svn.wordpress.org/trunk@27365 git-svn-id: http://core.svn.wordpress.org/trunk@27215 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes
parent
ce7191d2f9
commit
af8c5df4d0
|
|
@ -17,12 +17,6 @@
|
|||
* If the option was serialized then it will be unserialized when it is returned.
|
||||
*
|
||||
* @since 1.5.0
|
||||
* @uses apply_filters() Calls 'pre_option_$option' before checking the option.
|
||||
* Any value other than false will "short-circuit" the retrieval of the option
|
||||
* and return the returned value. You should not try to override special options,
|
||||
* but you will not be prevented from doing so.
|
||||
* @uses apply_filters() Calls 'option_$option', after checking the option, with
|
||||
* the option value.
|
||||
*
|
||||
* @param string $option Name of option to retrieve. Expected to not be SQL-escaped.
|
||||
* @param mixed $default Optional. Default value to return if the option does not exist.
|
||||
|
|
@ -35,7 +29,19 @@ function get_option( $option, $default = false ) {
|
|||
if ( empty( $option ) )
|
||||
return false;
|
||||
|
||||
// Allow plugins to short-circuit options.
|
||||
/**
|
||||
* Filter the value of an existing option before it is retrieved.
|
||||
*
|
||||
* The dynamic portion of the hook name, $option, refers to the option name.
|
||||
*
|
||||
* Passing a truthy value to the filter will short-circuit retrieving
|
||||
* the option value, returning the passed value instead.
|
||||
*
|
||||
* @since 1.5.0
|
||||
*
|
||||
* @param bool|mixed $pre_option Value to return instead of the option value.
|
||||
* Default false to skip it.
|
||||
*/
|
||||
$pre = apply_filters( 'pre_option_' . $option, false );
|
||||
if ( false !== $pre )
|
||||
return $pre;
|
||||
|
|
@ -47,6 +53,18 @@ function get_option( $option, $default = false ) {
|
|||
// prevent non-existent options from triggering multiple queries
|
||||
$notoptions = wp_cache_get( 'notoptions', 'options' );
|
||||
if ( isset( $notoptions[$option] ) )
|
||||
|
||||
/**
|
||||
* Filter the default value for an option.
|
||||
*
|
||||
* The dynamic portion of the hook name, $option, refers
|
||||
* to the option name.
|
||||
*
|
||||
* @since 3.4.0
|
||||
*
|
||||
* @param mixed $default The default value to return if the option
|
||||
* does not exist in the database.
|
||||
*/
|
||||
return apply_filters( 'default_option_' . $option, $default );
|
||||
|
||||
$alloptions = wp_load_alloptions();
|
||||
|
|
@ -66,6 +84,8 @@ function get_option( $option, $default = false ) {
|
|||
} else { // option does not exist, so we must cache its non-existence
|
||||
$notoptions[$option] = true;
|
||||
wp_cache_set( 'notoptions', $notoptions, 'options' );
|
||||
|
||||
/** This filter is documented in wp-includes/option.php */
|
||||
return apply_filters( 'default_option_' . $option, $default );
|
||||
}
|
||||
}
|
||||
|
|
@ -74,10 +94,12 @@ function get_option( $option, $default = false ) {
|
|||
$suppress = $wpdb->suppress_errors();
|
||||
$row = $wpdb->get_row( $wpdb->prepare( "SELECT option_value FROM $wpdb->options WHERE option_name = %s LIMIT 1", $option ) );
|
||||
$wpdb->suppress_errors( $suppress );
|
||||
if ( is_object( $row ) )
|
||||
if ( is_object( $row ) ) {
|
||||
$value = $row->option_value;
|
||||
else
|
||||
} else {
|
||||
/** This filter is documented in wp-includes/option.php */
|
||||
return apply_filters( 'default_option_' . $option, $default );
|
||||
}
|
||||
}
|
||||
|
||||
// If home is not set use siteurl.
|
||||
|
|
@ -87,6 +109,17 @@ function get_option( $option, $default = false ) {
|
|||
if ( in_array( $option, array('siteurl', 'home', 'category_base', 'tag_base') ) )
|
||||
$value = untrailingslashit( $value );
|
||||
|
||||
/**
|
||||
* Filter the value of an existing option.
|
||||
*
|
||||
* The dynamic portion of the hook name, $option, refers to the option name.
|
||||
*
|
||||
* @since 1.5.0 As 'option_' . $setting
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param mixed $value Value of the option. If stored serialized, it will be
|
||||
* unserialized prior to being returned.
|
||||
*/
|
||||
return apply_filters( 'option_' . $option, maybe_unserialize( $value ) );
|
||||
}
|
||||
|
||||
|
|
@ -191,11 +224,6 @@ function wp_load_core_site_options( $site_id = null ) {
|
|||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @uses apply_filters() Calls 'pre_update_option_$option' hook to allow overwriting the
|
||||
* option value to be stored.
|
||||
* @uses do_action() Calls 'update_option' hook before updating the option.
|
||||
* @uses do_action() Calls 'update_option_$option' and 'updated_option' hooks on success.
|
||||
*
|
||||
* @param string $option Option name. Expected to not be SQL-escaped.
|
||||
* @param mixed $value Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
|
||||
* @return bool False if value was not updated and true if value was updated.
|
||||
|
|
@ -214,6 +242,17 @@ function update_option( $option, $value ) {
|
|||
|
||||
$value = sanitize_option( $option, $value );
|
||||
$old_value = get_option( $option );
|
||||
|
||||
/**
|
||||
* Filter a specific option before its value is (maybe) serialized and updated.
|
||||
*
|
||||
* The dynamic portion of the hook name, $option, refers to the option name.
|
||||
*
|
||||
* @since 2.6.0
|
||||
*
|
||||
* @param mixed $value The new, unserialized option value.
|
||||
* @param mixed $old_value The old option value.
|
||||
*/
|
||||
$value = apply_filters( 'pre_update_option_' . $option, $value, $old_value );
|
||||
|
||||
// If the new and old values are the same, no need to update.
|
||||
|
|
@ -225,7 +264,17 @@ function update_option( $option, $value ) {
|
|||
|
||||
$serialized_value = maybe_serialize( $value );
|
||||
|
||||
/**
|
||||
* Fires immediately before an option value is updated.
|
||||
*
|
||||
* @since 2.9.0
|
||||
*
|
||||
* @param string $option Name of the option to update.
|
||||
* @param mixed $old_value The old option value.
|
||||
* @param mixed $value The new option value.
|
||||
*/
|
||||
do_action( 'update_option', $option, $old_value, $value );
|
||||
|
||||
$result = $wpdb->update( $wpdb->options, array( 'option_value' => $serialized_value ), array( 'option_name' => $option ) );
|
||||
if ( ! $result )
|
||||
return false;
|
||||
|
|
@ -246,7 +295,27 @@ function update_option( $option, $value ) {
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Fires after the value of a specific option has been successfully updated.
|
||||
*
|
||||
* The dynamic portion of the hook name, $option, refers to the option name.
|
||||
*
|
||||
* @since 2.0.1
|
||||
*
|
||||
* @param mixed $old_value The old option value.
|
||||
* @param mixed $value The new option value.
|
||||
*/
|
||||
do_action( "update_option_{$option}", $old_value, $value );
|
||||
|
||||
/**
|
||||
* Fires after the value of an option has been successfully updated.
|
||||
*
|
||||
* @since 2.9.0
|
||||
*
|
||||
* @param string $option Name of the updated option.
|
||||
* @param mixed $old_value The old option value.
|
||||
* @param mixed $value The new option value.
|
||||
*/
|
||||
do_action( 'updated_option', $option, $old_value, $value );
|
||||
return true;
|
||||
}
|
||||
|
|
@ -265,9 +334,6 @@ function update_option( $option, $value ) {
|
|||
*
|
||||
* @since 1.0.0
|
||||
*
|
||||
* @uses do_action() Calls 'add_option' hook before adding the option.
|
||||
* @uses do_action() Calls 'add_option_$option' and 'added_option' hooks on success.
|
||||
*
|
||||
* @param string $option Name of option to add. Expected to not be SQL-escaped.
|
||||
* @param mixed $value Optional. Option value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
|
||||
* @param mixed $deprecated Optional. Description. Not used anymore.
|
||||
|
|
@ -299,6 +365,15 @@ function add_option( $option, $value = '', $deprecated = '', $autoload = 'yes' )
|
|||
|
||||
$serialized_value = maybe_serialize( $value );
|
||||
$autoload = ( 'no' === $autoload ) ? 'no' : 'yes';
|
||||
|
||||
/**
|
||||
* Fires before an option is added.
|
||||
*
|
||||
* @since 2.9.0
|
||||
*
|
||||
* @param string $option Name of the option to add.
|
||||
* @param mixed $value Value of the option.
|
||||
*/
|
||||
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 ) );
|
||||
|
|
@ -322,7 +397,27 @@ function add_option( $option, $value = '', $deprecated = '', $autoload = 'yes' )
|
|||
wp_cache_set( 'notoptions', $notoptions, 'options' );
|
||||
}
|
||||
|
||||
/**
|
||||
* Fires after a specific option has been added.
|
||||
*
|
||||
* The dynamic portion of the hook name, $option, refers to the option name.
|
||||
*
|
||||
* @since 2.5.0 As "add_option_{$name}"
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $option Name of the option to add.
|
||||
* @param mixed $value Value of the option.
|
||||
*/
|
||||
do_action( "add_option_{$option}", $option, $value );
|
||||
|
||||
/**
|
||||
* Fires after an option has been added.
|
||||
*
|
||||
* @since 2.9.0
|
||||
*
|
||||
* @param string $option Name of the added option.
|
||||
* @param mixed $value Value of the option.
|
||||
*/
|
||||
do_action( 'added_option', $option, $value );
|
||||
return true;
|
||||
}
|
||||
|
|
@ -332,9 +427,6 @@ function add_option( $option, $value = '', $deprecated = '', $autoload = 'yes' )
|
|||
*
|
||||
* @since 1.2.0
|
||||
*
|
||||
* @uses do_action() Calls 'delete_option' hook before option is deleted.
|
||||
* @uses do_action() Calls 'deleted_option' and 'delete_option_$option' hooks on success.
|
||||
*
|
||||
* @param string $option Name of option to remove. Expected to not be SQL-escaped.
|
||||
* @return bool True, if option is successfully deleted. False on failure.
|
||||
*/
|
||||
|
|
@ -351,7 +443,16 @@ function delete_option( $option ) {
|
|||
$row = $wpdb->get_row( $wpdb->prepare( "SELECT autoload FROM $wpdb->options WHERE option_name = %s", $option ) );
|
||||
if ( is_null( $row ) )
|
||||
return false;
|
||||
|
||||
/**
|
||||
* Fires immediately before an option is deleted.
|
||||
*
|
||||
* @since 2.9.0
|
||||
*
|
||||
* @param string $option Name of the option to delete.
|
||||
*/
|
||||
do_action( 'delete_option', $option );
|
||||
|
||||
$result = $wpdb->delete( $wpdb->options, array( 'option_name' => $option ) );
|
||||
if ( ! defined( 'WP_INSTALLING' ) ) {
|
||||
if ( 'yes' == $row->autoload ) {
|
||||
|
|
@ -365,7 +466,25 @@ function delete_option( $option ) {
|
|||
}
|
||||
}
|
||||
if ( $result ) {
|
||||
|
||||
/**
|
||||
* Fires after a specific option has been deleted.
|
||||
*
|
||||
* The dynamic portion of the hook name, $option, refers to the option name.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $option Name of the deleted option.
|
||||
*/
|
||||
do_action( "delete_option_$option", $option );
|
||||
|
||||
/**
|
||||
* Fires after an option has been deleted.
|
||||
*
|
||||
* @since 2.9.0
|
||||
*
|
||||
* @param string $option Name of the deleted option.
|
||||
*/
|
||||
do_action( 'deleted_option', $option );
|
||||
return true;
|
||||
}
|
||||
|
|
@ -377,13 +496,20 @@ function delete_option( $option ) {
|
|||
*
|
||||
* @since 2.8.0
|
||||
*
|
||||
* @uses do_action() Calls 'delete_transient_$transient' hook before transient is deleted.
|
||||
* @uses do_action() Calls 'deleted_transient' hook on success.
|
||||
*
|
||||
* @param string $transient Transient name. Expected to not be SQL-escaped.
|
||||
* @return bool true if successful, false otherwise
|
||||
*/
|
||||
function delete_transient( $transient ) {
|
||||
|
||||
/**
|
||||
* Fires immediately before a specific transient is deleted.
|
||||
*
|
||||
* The dynamic portion of the hook name, $transient, refers to the transient name.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $transient Transient name.
|
||||
*/
|
||||
do_action( 'delete_transient_' . $transient, $transient );
|
||||
|
||||
if ( wp_using_ext_object_cache() ) {
|
||||
|
|
@ -396,8 +522,18 @@ function delete_transient( $transient ) {
|
|||
delete_option( $option_timeout );
|
||||
}
|
||||
|
||||
if ( $result )
|
||||
if ( $result ) {
|
||||
|
||||
/**
|
||||
* Fires after a transient is deleted.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $transient Deleted transient name.
|
||||
*/
|
||||
do_action( 'deleted_transient', $transient );
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
|
|
@ -407,18 +543,27 @@ function delete_transient( $transient ) {
|
|||
* If the transient does not exist or does not have a value, then the return value
|
||||
* will be false.
|
||||
*
|
||||
* @uses apply_filters() Calls 'pre_transient_$transient' hook before checking the transient.
|
||||
* Any value other than false will "short-circuit" the retrieval of the transient
|
||||
* and return the returned value.
|
||||
* @uses apply_filters() Calls 'transient_$option' hook, after checking the transient, with
|
||||
* the transient value.
|
||||
*
|
||||
* @since 2.8.0
|
||||
*
|
||||
* @param string $transient Transient name. Expected to not be SQL-escaped
|
||||
* @return mixed Value of transient
|
||||
*/
|
||||
function get_transient( $transient ) {
|
||||
|
||||
/**
|
||||
* Filter the value of an existing transient.
|
||||
*
|
||||
* The dynamic portion of the hook name, $transient, refers to the transient name.
|
||||
*
|
||||
* Passing a truthy value to the filter will effectively short-circuit retrieval
|
||||
* of the transient, returning the passed value instead.
|
||||
*
|
||||
* @since 2.8.0
|
||||
*
|
||||
* @param mixed $pre_transient The default value to return if the transient does not exist.
|
||||
* Any value other than false will short-circuit the retrieval
|
||||
* of the transient, and return the returned value.
|
||||
*/
|
||||
$pre = apply_filters( 'pre_transient_' . $transient, false );
|
||||
if ( false !== $pre )
|
||||
return $pre;
|
||||
|
|
@ -444,6 +589,15 @@ function get_transient( $transient ) {
|
|||
$value = get_option( $transient_option );
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter an existing transient's value.
|
||||
*
|
||||
* The dynamic portion of the hook name, $transient, refers to the transient name.
|
||||
*
|
||||
* @since 2.8.0
|
||||
*
|
||||
* @param mixed $value Value of transient.
|
||||
*/
|
||||
return apply_filters( 'transient_' . $transient, $value );
|
||||
}
|
||||
|
||||
|
|
@ -455,17 +609,24 @@ function get_transient( $transient ) {
|
|||
*
|
||||
* @since 2.8.0
|
||||
*
|
||||
* @uses apply_filters() Calls 'pre_set_transient_$transient' hook to allow overwriting the
|
||||
* transient value to be stored.
|
||||
* @uses do_action() Calls 'set_transient_$transient' and 'setted_transient' hooks on success.
|
||||
*
|
||||
* @param string $transient Transient name. Expected to not be SQL-escaped.
|
||||
* @param mixed $value Transient value. Must be serializable if non-scalar. Expected to not be SQL-escaped.
|
||||
* @param int $expiration Time until expiration in seconds, default 0
|
||||
* @return bool False if value was not set and true if value was set.
|
||||
*/
|
||||
function set_transient( $transient, $value, $expiration = 0 ) {
|
||||
|
||||
/**
|
||||
* Filter a specific transient before its value is set.
|
||||
*
|
||||
* The dynamic portion of the hook name, $transient, refers to the transient name.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param mixed $value New value of transient.
|
||||
*/
|
||||
$value = apply_filters( 'pre_set_transient_' . $transient, $value );
|
||||
|
||||
$expiration = (int) $expiration;
|
||||
|
||||
if ( wp_using_ext_object_cache() ) {
|
||||
|
|
@ -486,8 +647,30 @@ function set_transient( $transient, $value, $expiration = 0 ) {
|
|||
$result = update_option( $transient, $value );
|
||||
}
|
||||
}
|
||||
|
||||
if ( $result ) {
|
||||
|
||||
/**
|
||||
* Fires after the value for a specific transient has been set.
|
||||
*
|
||||
* The dynamic portion of the hook name, $transient, refers to the transient name.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param mixed $value Transient value.
|
||||
* @param int $expiration Time until expiration in seconds. Default 0.
|
||||
*/
|
||||
do_action( 'set_transient_' . $transient, $value, $expiration );
|
||||
|
||||
/**
|
||||
* Fires after the value for a transient has been set.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $transient The name of the transient.
|
||||
* @param mixed $value Transient value.
|
||||
* @param int $expiration Time until expiration in seconds. Default 0.
|
||||
*/
|
||||
do_action( 'setted_transient', $transient, $value, $expiration );
|
||||
}
|
||||
return $result;
|
||||
|
|
@ -697,14 +880,9 @@ function delete_all_user_settings() {
|
|||
/**
|
||||
* Retrieve site option value based on name of option.
|
||||
*
|
||||
* @see get_option()
|
||||
* @since 2.8.0
|
||||
*
|
||||
* @uses apply_filters() Calls 'pre_site_option_$option' before checking the option.
|
||||
* Any value other than false will "short-circuit" the retrieval of the option
|
||||
* and return the returned value.
|
||||
* @uses apply_filters() Calls 'site_option_$option', after checking the option, with
|
||||
* the option value.
|
||||
* @see get_option()
|
||||
*
|
||||
* @param string $option Name of option to retrieve. Expected to not be SQL-escaped.
|
||||
* @param mixed $default Optional value to return if option doesn't exist. Default false.
|
||||
|
|
@ -714,18 +892,46 @@ function delete_all_user_settings() {
|
|||
function get_site_option( $option, $default = false, $use_cache = true ) {
|
||||
global $wpdb;
|
||||
|
||||
// Allow plugins to short-circuit site options.
|
||||
/**
|
||||
* Filter an existing site option before it is retrieved.
|
||||
*
|
||||
* The dynamic portion of the hook name, $option, refers to the option name.
|
||||
*
|
||||
* Passing a truthy value to the filter will effectively short-circuit retrieval,
|
||||
* returning the passed value instead.
|
||||
*
|
||||
* @since 2.9.0 As 'pre_site_option_' . $key
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param mixed $pre_option The default value to return if the option does not exist.
|
||||
*/
|
||||
$pre = apply_filters( 'pre_site_option_' . $option, false );
|
||||
|
||||
if ( false !== $pre )
|
||||
return $pre;
|
||||
|
||||
// prevent non-existent options from triggering multiple queries
|
||||
$notoptions_key = "{$wpdb->siteid}:notoptions";
|
||||
$notoptions = wp_cache_get( $notoptions_key, 'site-options' );
|
||||
if ( isset( $notoptions[$option] ) )
|
||||
|
||||
if ( isset( $notoptions[$option] ) ) {
|
||||
|
||||
/**
|
||||
* Filter a specific default site option.
|
||||
*
|
||||
* The dynamic portion of the hook name, $option, refers to the option name.
|
||||
*
|
||||
* @since 3.4.0
|
||||
*
|
||||
* @param mixed $default The value to return if the site option does not exist
|
||||
* in the database.
|
||||
*/
|
||||
return apply_filters( 'default_site_option_' . $option, $default );
|
||||
}
|
||||
|
||||
if ( ! is_multisite() ) {
|
||||
|
||||
/** This filter is documented in wp-includes/option.php */
|
||||
$default = apply_filters( 'default_site_option_' . $option, $default );
|
||||
$value = get_option($option, $default);
|
||||
} else {
|
||||
|
|
@ -744,11 +950,23 @@ function get_site_option( $option, $default = false, $use_cache = true ) {
|
|||
} else {
|
||||
$notoptions[$option] = true;
|
||||
wp_cache_set( $notoptions_key, $notoptions, 'site-options' );
|
||||
|
||||
/** This filter is documented in wp-includes/option.php */
|
||||
$value = apply_filters( 'default_site_option_' . $option, $default );
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter the value of an existing site option.
|
||||
*
|
||||
* The dynamic portion of the hook name, $option, refers to the option name.
|
||||
*
|
||||
* @since 2.9.0 As 'site_option_' . $key
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param mixed $value Value of site option.
|
||||
*/
|
||||
return apply_filters( 'site_option_' . $option, $value );
|
||||
}
|
||||
|
||||
|
|
@ -757,12 +975,9 @@ function get_site_option( $option, $default = false, $use_cache = true ) {
|
|||
*
|
||||
* Existing options will not be updated. Note that prior to 3.3 this wasn't the case.
|
||||
*
|
||||
* @see add_option()
|
||||
* @since 2.8.0
|
||||
*
|
||||
* @uses apply_filters() Calls 'pre_add_site_option_$option' hook to allow overwriting the
|
||||
* option value to be stored.
|
||||
* @uses do_action() Calls 'add_site_option_$option' and 'add_site_option' hooks on success.
|
||||
* @see add_option()
|
||||
*
|
||||
* @param string $option Name of option to add. Expected to not be SQL-escaped.
|
||||
* @param mixed $value Optional. Option value, can be anything. Expected to not be SQL-escaped.
|
||||
|
|
@ -773,7 +988,18 @@ function add_site_option( $option, $value ) {
|
|||
|
||||
wp_protect_special_option( $option );
|
||||
|
||||
/**
|
||||
* Filter the value of a specific site option before it is added.
|
||||
*
|
||||
* The dynamic portion of the hook name, $option, refers to the option name.
|
||||
*
|
||||
* @since 2.9.0 As 'pre_add_site_option_' . $key
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param mixed $value Value of site option.
|
||||
*/
|
||||
$value = apply_filters( 'pre_add_site_option_' . $option, $value );
|
||||
|
||||
$notoptions_key = "{$wpdb->siteid}:notoptions";
|
||||
|
||||
if ( !is_multisite() ) {
|
||||
|
|
@ -806,8 +1032,30 @@ function add_site_option( $option, $value ) {
|
|||
}
|
||||
|
||||
if ( $result ) {
|
||||
|
||||
/**
|
||||
* Fires after a specific site option has been successfully added.
|
||||
*
|
||||
* The dynamic portion of the hook name, $option, refers to the option name.
|
||||
*
|
||||
* @since 2.9.0 As "add_site_option_{$key}"
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $option Name of site option.
|
||||
* @param mixed $value Value of site option.
|
||||
*/
|
||||
do_action( "add_site_option_{$option}", $option, $value );
|
||||
|
||||
/**
|
||||
* Fires after a site option has been successfully added.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $option Name of site option.
|
||||
* @param mixed $value Value of site option.
|
||||
*/
|
||||
do_action( "add_site_option", $option, $value );
|
||||
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
|
|
@ -816,12 +1064,9 @@ function add_site_option( $option, $value ) {
|
|||
/**
|
||||
* Removes site option by name.
|
||||
*
|
||||
* @see delete_option()
|
||||
* @since 2.8.0
|
||||
*
|
||||
* @uses do_action() Calls 'pre_delete_site_option_$option' hook before option is deleted.
|
||||
* @uses do_action() Calls 'delete_site_option' and 'delete_site_option_$option'
|
||||
* hooks on success.
|
||||
* @see delete_option()
|
||||
*
|
||||
* @param string $option Name of option to remove. Expected to not be SQL-escaped.
|
||||
* @return bool True, if succeed. False, if failure.
|
||||
|
|
@ -831,6 +1076,13 @@ function delete_site_option( $option ) {
|
|||
|
||||
// ms_protect_special_option( $option ); @todo
|
||||
|
||||
/**
|
||||
* Fires immediately before a specific site option is deleted.
|
||||
*
|
||||
* The dynamic portion of the hook name, $option, refers to the option name.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*/
|
||||
do_action( 'pre_delete_site_option_' . $option );
|
||||
|
||||
if ( !is_multisite() ) {
|
||||
|
|
@ -846,8 +1098,28 @@ function delete_site_option( $option ) {
|
|||
}
|
||||
|
||||
if ( $result ) {
|
||||
|
||||
/**
|
||||
* Fires after a specific site option has been deleted.
|
||||
*
|
||||
* The dynamic portion of the hook name, $option, refers to the option name.
|
||||
*
|
||||
* @since 2.9.0 As "delete_site_option_{$key}"
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $option Name of the site option.
|
||||
*/
|
||||
do_action( "delete_site_option_{$option}", $option );
|
||||
|
||||
/**
|
||||
* Fires after a site option has been deleted.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $option Name of the site option.
|
||||
*/
|
||||
do_action( "delete_site_option", $option );
|
||||
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
|
|
@ -856,12 +1128,9 @@ function delete_site_option( $option ) {
|
|||
/**
|
||||
* Update the value of a site option that was already added.
|
||||
*
|
||||
* @see update_option()
|
||||
* @since 2.8.0
|
||||
*
|
||||
* @uses apply_filters() Calls 'pre_update_site_option_$option' hook to allow overwriting the
|
||||
* option value to be stored.
|
||||
* @uses do_action() Calls 'update_site_option_$option' and 'update_site_option' hooks on success.
|
||||
* @see update_option()
|
||||
*
|
||||
* @param string $option Name of option. Expected to not be SQL-escaped.
|
||||
* @param mixed $value Option value. Expected to not be SQL-escaped.
|
||||
|
|
@ -873,6 +1142,18 @@ function update_site_option( $option, $value ) {
|
|||
wp_protect_special_option( $option );
|
||||
|
||||
$old_value = get_site_option( $option );
|
||||
|
||||
/**
|
||||
* Filter a specific site option before its value is updated.
|
||||
*
|
||||
* The dynamic portion of the hook name, $option, refers to the option name.
|
||||
*
|
||||
* @since 2.9.0 As 'pre_update_site_option_' . $key
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param mixed $value New value of site option.
|
||||
* @param mixed $old_value Old value of site option.
|
||||
*/
|
||||
$value = apply_filters( 'pre_update_site_option_' . $option, $value, $old_value );
|
||||
|
||||
if ( $value === $old_value )
|
||||
|
|
@ -903,8 +1184,32 @@ function update_site_option( $option, $value ) {
|
|||
}
|
||||
|
||||
if ( $result ) {
|
||||
|
||||
/**
|
||||
* Fires after the value of a specific site option has been successfully updated.
|
||||
*
|
||||
* The dynamic portion of the hook name, $option, refers to the option name.
|
||||
*
|
||||
* @since 2.9.0 As "update_site_option_{$key}"
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $option Name of site option.
|
||||
* @param mixed $value Current value of site option.
|
||||
* @param mixed $old_value Old value of site option.
|
||||
*/
|
||||
do_action( "update_site_option_{$option}", $option, $value, $old_value );
|
||||
|
||||
/**
|
||||
* Fires after the value of a site option has been successfully updated.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $option Name of site option.
|
||||
* @param mixed $value Current value of site option.
|
||||
* @param mixed $old_value Old value of site option.
|
||||
*/
|
||||
do_action( "update_site_option", $option, $value, $old_value );
|
||||
|
||||
return true;
|
||||
}
|
||||
return false;
|
||||
|
|
@ -915,14 +1220,22 @@ function update_site_option( $option, $value ) {
|
|||
*
|
||||
* @since 2.9.0
|
||||
*
|
||||
* @uses do_action() Calls 'delete_site_transient_$transient' hook before transient is deleted.
|
||||
* @uses do_action() Calls 'deleted_site_transient' hook on success.
|
||||
*
|
||||
* @param string $transient Transient name. Expected to not be SQL-escaped.
|
||||
* @return bool True if successful, false otherwise
|
||||
*/
|
||||
function delete_site_transient( $transient ) {
|
||||
|
||||
/**
|
||||
* Fires immediately before a specific site transient is deleted.
|
||||
*
|
||||
* The dynamic portion of the hook name, $transient, refers to the transient name.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $transient Transient name.
|
||||
*/
|
||||
do_action( 'delete_site_transient_' . $transient, $transient );
|
||||
|
||||
if ( wp_using_ext_object_cache() ) {
|
||||
$result = wp_cache_delete( $transient, 'site-transient' );
|
||||
} else {
|
||||
|
|
@ -932,8 +1245,18 @@ function delete_site_transient( $transient ) {
|
|||
if ( $result )
|
||||
delete_site_option( $option_timeout );
|
||||
}
|
||||
if ( $result )
|
||||
if ( $result ) {
|
||||
|
||||
/**
|
||||
* Fires after a transient is deleted.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $transient Deleted transient name.
|
||||
*/
|
||||
do_action( 'deleted_site_transient', $transient );
|
||||
}
|
||||
|
||||
return $result;
|
||||
}
|
||||
|
||||
|
|
@ -943,20 +1266,31 @@ function delete_site_transient( $transient ) {
|
|||
* If the transient does not exist or does not have a value, then the return value
|
||||
* will be false.
|
||||
*
|
||||
* @see get_transient()
|
||||
* @since 2.9.0
|
||||
*
|
||||
* @uses apply_filters() Calls 'pre_site_transient_$transient' hook before checking the transient.
|
||||
* Any value other than false will "short-circuit" the retrieval of the transient
|
||||
* and return the returned value.
|
||||
* @uses apply_filters() Calls 'site_transient_$option' hook, after checking the transient, with
|
||||
* the transient value.
|
||||
* @see get_transient()
|
||||
*
|
||||
* @param string $transient Transient name. Expected to not be SQL-escaped.
|
||||
* @return mixed Value of transient
|
||||
*/
|
||||
function get_site_transient( $transient ) {
|
||||
|
||||
/**
|
||||
* Filter the value of an existing site transient.
|
||||
*
|
||||
* The dynamic portion of the hook name, $transient, refers to the transient name.
|
||||
*
|
||||
* Passing a truthy value to the filter will effectively short-circuit retrieval,
|
||||
* returning the passed value instead.
|
||||
*
|
||||
* @since 2.9.0
|
||||
*
|
||||
* @param mixed $pre_site_transient The default value to return if the site transient does not exist.
|
||||
* Any value other than false will short-circuit the retrieval
|
||||
* of the transient, and return the returned value.
|
||||
*/
|
||||
$pre = apply_filters( 'pre_site_transient_' . $transient, false );
|
||||
|
||||
if ( false !== $pre )
|
||||
return $pre;
|
||||
|
||||
|
|
@ -980,6 +1314,15 @@ function get_site_transient( $transient ) {
|
|||
$value = get_site_option( $transient_option );
|
||||
}
|
||||
|
||||
/**
|
||||
* Filter the value of an existing site transient.
|
||||
*
|
||||
* The dynamic portion of the hook name, $transient, refers to the transient name.
|
||||
*
|
||||
* @since 2.9.0
|
||||
*
|
||||
* @param mixed $value Value of site transient.
|
||||
*/
|
||||
return apply_filters( 'site_transient_' . $transient, $value );
|
||||
}
|
||||
|
||||
|
|
@ -989,12 +1332,9 @@ function get_site_transient( $transient ) {
|
|||
* You do not need to serialize values, if the value needs to be serialize, then
|
||||
* it will be serialized before it is set.
|
||||
*
|
||||
* @see set_transient()
|
||||
* @since 2.9.0
|
||||
*
|
||||
* @uses apply_filters() Calls 'pre_set_site_transient_$transient' hook to allow overwriting the
|
||||
* transient value to be stored.
|
||||
* @uses do_action() Calls 'set_site_transient_$transient' and 'setted_site_transient' hooks on success.
|
||||
* @see set_transient()
|
||||
*
|
||||
* @param string $transient Transient name. Expected to not be SQL-escaped.
|
||||
* @param mixed $value Transient value. Expected to not be SQL-escaped.
|
||||
|
|
@ -1002,7 +1342,18 @@ function get_site_transient( $transient ) {
|
|||
* @return bool False if value was not set and true if value was set.
|
||||
*/
|
||||
function set_site_transient( $transient, $value, $expiration = 0 ) {
|
||||
|
||||
/**
|
||||
* Filter the value of a specific site transient before it is set.
|
||||
*
|
||||
* The dynamic portion of the hook name, $transient, refers to the transient name.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param mixed $value Value of site transient.
|
||||
*/
|
||||
$value = apply_filters( 'pre_set_site_transient_' . $transient, $value );
|
||||
|
||||
$expiration = (int) $expiration;
|
||||
|
||||
if ( wp_using_ext_object_cache() ) {
|
||||
|
|
@ -1021,7 +1372,28 @@ function set_site_transient( $transient, $value, $expiration = 0 ) {
|
|||
}
|
||||
}
|
||||
if ( $result ) {
|
||||
|
||||
/**
|
||||
* Fires after the value for a specific site transient has been set.
|
||||
*
|
||||
* The dynamic portion of the hook name, $transient, refers to the transient name.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param mixed $value Site transient value.
|
||||
* @param int $expiration Time until expiration in seconds. Default 0.
|
||||
*/
|
||||
do_action( 'set_site_transient_' . $transient, $value, $expiration );
|
||||
|
||||
/**
|
||||
* Fires after the value for a site transient has been set.
|
||||
*
|
||||
* @since 3.0.0
|
||||
*
|
||||
* @param string $transient The name of the site transient.
|
||||
* @param mixed $value Site transient value.
|
||||
* @param int $expiration Time until expiration in seconds. Default 0.
|
||||
*/
|
||||
do_action( 'setted_site_transient', $transient, $value, $expiration );
|
||||
}
|
||||
return $result;
|
||||
|
|
|
|||
Loading…
Reference in New Issue