Changeset 11922

Timestamp:

09/13/2009 08:34:24 AM (15 years ago)

Author:

westi

Message:

phpDoc for wp_{check|set}_post_lock functions.

File:

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

trunk/wp-admin/includes/post.php

@@ -1027 +1027 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $post_id
+ * Check to see if the post is currently being edited by another user.
+ *
+ * @since 2.5.0
+ *
+ * @param int $post_id ID of the post to check for editing
  * @return bool|int False: not locked or locked by current user. Int: user ID of user with lock.
  */
@@ -1051 +1051 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $post_id
- * @return unknown
+ * Mark the post as currently being edited by the current user
+ *
+ * @since 2.5.0
+ *
+ * @param int $post_id ID of the post to being edited
+ * @return bool Returns false if the post doesn't exist of there is no current user
  */
 function wp_set_post_lock( $post_id ) {