Changeset 42796

Timestamp:

03/08/2018 03:56:50 AM (7 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for add_meta_boxes and do_meta_boxes actions.

Props danieltj, johnbillion, SergeyBiryukov.
Fixes #43229.

File:

• trunk/src/wp-admin/edit-form-advanced.php (modified) (2 diffs)

trunk/src/wp-admin/edit-form-advanced.php

@@ -358 +358 @@
  * @since 3.0.0
  *
- * @param string  $post_type Post type.
- * @param WP_Post $post      Post object.
+ * @param string                    $post_type Post type for posts, 'comment' for comments,
+ *                                             'link' for links.
+ * @param WP_Post|WP_Comment|object $post      Post, comment, or link object.
  */
 do_action( 'add_meta_boxes', $post_type, $post );
@@ -381 +382 @@
  * @since 3.0.0
  *
- * @param string  $post_type Post type of the post.
- * @param string  $context   string  Meta box context.
- * @param WP_Post $post      Post object.
+ * @param string                $post_type Post type for posts, 'dashboard' for dashboard widgets,
+ *                                         'link' for links.
+ * @param string                $context   Meta box context. Accepts 'normal', 'advanced', 'side'.
+ * @param WP_Post|string|object $post      Post object for posts, empty string for dashboard widgets,
+ *                                         link object for links.
  */
 do_action( 'do_meta_boxes', $post_type, 'normal', $post );