Docs: Improve documentation for WP_Upgrader::release_lock(), introduced in [36349].

See #34878. See #35986.


git-svn-id: https://develop.svn.wordpress.org/trunk@36822 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-03-03 07:10:58 +00:00
parent 5fc3cdb07e
commit ecc7d4f1b3

View File

@ -799,14 +799,16 @@ class WP_Upgrader {
} }
/** /**
* Release a lock created by `WP_Upgrader::create_lock()`. * Releases an upgrader lock.
* *
* @since 4.5.0 * @since 4.5.0
* @access public * @access public
* @static * @static
*
* @see WP_Upgrader::create_lock()
* *
* @param string $lock_name The name of this unique lock. * @param string $lock_name The name of this unique lock.
* @return bool * @return bool True if the lock was successfully released. False on failure.
*/ */
public static function release_lock( $lock_name ) { public static function release_lock( $lock_name ) {
return delete_option( $lock_name . '.lock' ); return delete_option( $lock_name . '.lock' );