Changeset 40423

Timestamp:

04/13/2017 11:01:20 PM (10 years ago)

Author:

SergeyBiryukov

Message:

Posts, Post Types: Improve the docs for wp_check_post_lock() and wp_set_post_lock().

See #39888.

File:

• trunk/src/wp-admin/includes/post.php (modified) (4 diffs)

trunk/src/wp-admin/includes/post.php

@@ -1449 +1449 @@
  * @since 2.5.0
  *
- * @param int $post_id ID of the post to check for editing
- * @return integer False: not locked or locked by current user. Int: user ID of user with lock.
+ * @param int $post_id ID of the post to check for editing.
+ * @return int|false ID of the user with lock. False if the post does not exist, post is not locked,
+ *                   or post is locked by current user.
  */
 function wp_check_post_lock( $post_id ) {
-        if ( !$post = get_post( $post_id ) )
+        if ( ! $post = get_post( $post_id ) ) {
                 return false;
-
-        if ( !$lock = get_post_meta( $post->ID, '_edit_lock', true ) )
+        }
+
+        if ( ! $lock = get_post_meta( $post->ID, '_edit_lock', true ) ) {
                 return false;
+        }
 
         $lock = explode( ':', $lock );
@@ -1466 +1469 @@
         $time_window = apply_filters( 'wp_check_post_lock_window', 150 );
 
-        if ( $time && $time > time() - $time_window && $user != get_current_user_id() )
+        if ( $time && $time > time() - $time_window && $user != get_current_user_id() ) {
                 return $user;
+        }
+
         return false;
 }
@@ -1476 +1481 @@
  * @since 2.5.0
  *
- * @param int $post_id ID of the post to being edited
- * @return bool|array Returns false if the post doesn't exist of there is no current user, or
- *      an array of the lock time and the user ID.
+ * @param int $post_id ID of the post being edited.
+ * @return array|false Array of the lock time and user ID. False if the post does not exist or there
+ *                     is no current user.
  */
 function wp_set_post_lock( $post_id ) {
-        if ( !$post = get_post( $post_id ) )
+        if ( ! $post = get_post( $post_id ) ) {
                 return false;
-        if ( 0 == ($user_id = get_current_user_id()) )
+        }
+
+        if ( 0 == ( $user_id = get_current_user_id() ) ) {
                 return false;
+        }
 
         $now = time();
@@ -1490 +1498 @@
 
         update_post_meta( $post->ID, '_edit_lock', $lock );
+
         return array( $now, $user_id );
 }