Changeset 25819

Timestamp:

10/16/2013 10:58:21 PM (11 years ago)

Author:

DrewAPicture

Message:

Inline documentation for hooks in wp-admin/edit-form-advanced.php.

Props ericlewis.
Fixes #25434.

File:

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

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

@@ -33 +33 @@
 add_action( 'admin_footer', '_local_storage_notice' );
 
+/*
+ * @todo Document the $messages array(s).
+ */
 $messages = array();
 $messages['post'] = array(
@@ -65 +68 @@
 $messages['attachment'] = array_fill( 1, 10, __( 'Media attachment updated.' ) ); // Hack, for now.
 
+/**
+ * Filter the post updated messages.
+ *
+ * @since 3.0.0
+ *
+ * @param array $messages Post updated messages. For defaults @see $messages declarations above.
+ */
 $messages = apply_filters( 'post_updated_messages', $messages );
 
@@ -173 +183 @@
     add_meta_box('postcustom', __('Custom Fields'), 'post_custom_meta_box', null, 'normal', 'core');
 
-do_action('dbx_post_advanced', $post);
+/**
+ * Fires in the middle of built-in meta box registration.
+ *
+ * @since 2.1.0
+ * @deprecated 3.7.0 Use 'add_meta_boxes' instead.
+ *
+ * @param WP_Post $post Post object.
+ */
+do_action( 'dbx_post_advanced', $post );
+
 if ( post_type_supports($post_type, 'comments') )
     add_meta_box('commentstatusdiv', __('Discussion'), 'post_comment_status_meta_box', null, 'normal', 'core');
@@ -188 +207 @@
 }
 
-do_action('add_meta_boxes', $post_type, $post);
-do_action('add_meta_boxes_' . $post_type, $post);
-
-do_action('do_meta_boxes', $post_type, 'normal', $post);
-do_action('do_meta_boxes', $post_type, 'advanced', $post);
-do_action('do_meta_boxes', $post_type, 'side', $post);
+/**
+ * Fires after all built-in meta boxes have been added.
+ *
+ * @since 3.0.0
+ *
+ * @param string  $post_type Post type.
+ * @param WP_Post $post      Post object.
+ */
+do_action( 'add_meta_boxes', $post_type, $post );
+
+/**
+ * Fires after all built-in meta boxes have been added, contextually for the given post type.
+ *
+ * The dynamic portion of the hook, $post_type, refers to the post type of the post.
+ *
+ * @since 3.0.0
+ *
+ * @param WP_Post $post Post object.
+ */
+do_action( 'add_meta_boxes_' . $post_type, $post );
+
+/**
+ * Fires after meta boxes have been added.
+ *
+ * Fires once for each of the default meta box contexts: normal, advanced, and side.
+ *
+ * @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.
+ */
+do_action( 'do_meta_boxes', $post_type, 'normal', $post );
+//duplicate_hook
+do_action( 'do_meta_boxes', $post_type, 'advanced', $post );
+//duplicate_hook
+do_action( 'do_meta_boxes', $post_type, 'side', $post );
 
 add_screen_option('layout_columns', array('max' => 2, 'default' => 2) );
@@ -327 +377 @@
     </p>
 </div>
-
-<form name="post" action="post.php" method="post" id="post"<?php do_action('post_edit_form_tag', $post); ?>>
+<?php
+/**
+ * Fires inside the post editor <form> tag.
+ *
+ * @since 3.0.0
+ *
+ * @param WP_Post $post Post object.
+ */
+?>
+<form name="post" action="post.php" method="post" id="post"<?php do_action( 'post_edit_form_tag', $post ); ?>>
 <?php wp_nonce_field($nonce_action); ?>
 <input type="hidden" id="user-id" name="user_ID" value="<?php echo (int) $user_ID ?>" />
@@ -351 +409 @@
 ?>
 
-<?php do_action( 'edit_form_top', $post ); ?>
+<?php
+/**
+ * Fires at the beginning of the edit form.
+ *
+ * At this point, the required hidden fields and nonces have already been output.
+ *
+ * @since 3.7.0
+ *
+ * @param WP_Post $post Post object.
+ */
+do_action( 'edit_form_top', $post ); ?>
 
 <div id="poststuff">
@@ -360 +428 @@
 <div id="titlediv">
 <div id="titlewrap">
+    <?php
+    /**
+     * Filter the title field placeholder text.
+     *
+     * @since 3.1.0
+     *
+     * @param string  $text Placeholder text. Default 'Enter title here'.
+     * @param WP_Post $post Post object.
+     */
+    ?>
     <label class="screen-reader-text" id="title-prompt-text" for="title"><?php echo apply_filters( 'enter_title_here', __( 'Enter title here' ), $post ); ?></label>
     <input type="text" name="post_title" size="30" value="<?php echo esc_attr( htmlspecialchars( $post->post_title ) ); ?>" id="title" autocomplete="off" />
@@ -390 +468 @@
 <?php
 }
-
+/**
+ * Fires after the title field.
+ *
+ * @since 3.5.0
+ *
+ * @param WP_Post $post Post object.
+ */
 do_action( 'edit_form_after_title', $post );
 
@@ -421 +505 @@
 </div>
 <?php }
-
+/**
+ * Fires after the content editor.
+ *
+ * @since 3.5.0
+ *
+ * @param WP_Post $post Post object.
+ */
 do_action( 'edit_form_after_editor', $post );
 ?>
@@ -429 +519 @@
 <?php
 
-if ( 'page' == $post_type )
-    do_action('submitpage_box', $post);
-else
-    do_action('submitpost_box', $post);
+if ( 'page' == $post_type ) {
+    /**
+     * Fires before meta boxes with 'side' context are output for the 'page' post type.
+     *
+     * The submitpage box is a meta box with 'side' context, so this hook fires just before it is output.
+     *
+     * @since 2.5.0
+     *
+     * @param WP_Post $post Post object.
+     */
+    do_action( 'submitpage_box', $post );
+}
+else {
+    /**
+     * Fires before meta boxes with 'side' context are output for all post types other than 'page'.
+     *
+     * The submitpost box is a meta box with 'side' context, so this hook fires just before it is output.
+     *
+     * @since 2.5.0
+     *
+     * @param WP_Post $post Post object.
+     */
+    do_action( 'submitpost_box', $post );
+}
+
 
 do_meta_boxes($post_type, 'side', $post);
@@ -443 +554 @@
 do_meta_boxes(null, 'normal', $post);
 
-if ( 'page' == $post_type )
-    do_action('edit_page_form', $post);
-else
-    do_action('edit_form_advanced', $post);
+if ( 'page' == $post_type ) {
+    /**
+     * Fires after 'normal' context meta boxes have been output for the 'page' post type.
+     *
+     * @since 1.5.2
+     *
+     * @param WP_Post $post Post object.
+     */
+    do_action( 'edit_page_form', $post );
+}
+else {
+    /**
+     * Fires after 'normal' context meta boxes have been output for all post types other than 'page'.
+     *
+     * @since 1.5.2
+     *
+     * @param WP_Post $post Post object.
+     */
+    do_action( 'edit_form_advanced', $post );
+}
+
 
 do_meta_boxes(null, 'advanced', $post);
@@ -453 +581 @@
 </div>
 <?php
-
-do_action('dbx_post_sidebar', $post);
+/**
+ * Fires after all meta box sections have been output, before the closing #post-body div.
+ *
+ * @since 2.1.0
+ *
+ * @param WP_Post $post Post object.
+ */
+do_action( 'dbx_post_sidebar', $post );
 
 ?>