Changeset 42397

Timestamp:

12/15/2017 01:01:01 AM (7 years ago)

Author:

SergeyBiryukov

Message:

Docs: Add missing parameter description in wp_get_post_parent_id() function DocBlock.

Rename $post_ID to $post for consistency with other functions.

Add unit tests for wp_get_post_parent_id().

Props keesiemeijer.
Fixes #42797.

Location:

trunk

Files:

• src/wp-includes/post.php (modified) (1 diff)
• tests/phpunit/tests/post/wpGetPostParentId.php (added)

trunk/src/wp-includes/post.php

@@ -6252 +6252 @@
 
 /**
- * Return the post's parent's post_ID
+ * Return the post's parent post ID.
  *
  * @since 3.1.0
  *
- * @param int $post_ID
- *
+ * @param int|WP_Post $post Post ID or post object. Defaults to global $post.
  * @return int|false Post parent ID, otherwise false.
  */
-function wp_get_post_parent_id( $post_ID ) {
-    $post = get_post( $post_ID );
+function wp_get_post_parent_id( $post ) {
+    $post = get_post( $post );
     if ( ! $post || is_wp_error( $post ) ) {
         return false;