Changeset 26129

Timestamp:

11/13/2013 11:57:11 AM (12 years ago)

Author:

SergeyBiryukov

Message:

Inline documentation for hooks in wp-mail.php.

props kpdesign, radices.
fixes #25551.

File:

• trunk/src/wp-mail.php (modified) (4 diffs)

trunk/src/wp-mail.php

@@ -15 +15 @@
     wp_die( __( 'This action has been disabled by the administrator.' ) );
 
-/** Allow a plugin to do a complete takeover of Post by Email **/
-do_action('wp-mail.php');
+/**
+ * Fires to allow a plugin to do a complete takeover of Post by Email.
+ *
+ * @since 2.9.0
+ */
+do_action( 'wp-mail.php' );
 
 /** Get the POP3 class with which to access the mailbox. */
@@ -177 +181 @@
     $content = trim($content);
 
-    //Give Post-By-Email extending plugins full access to the content
-    //Either the raw content or the content of the last quoted-printable section
-    $content = apply_filters('wp_mail_original_content', $content);
+    /**
+     * Filter the original content of the email.
+     *
+     * Give Post-By-Email extending plugins full access to the content, either
+     * the raw content, or the content of the last quoted-printable section.
+     *
+     * @since 2.8.0
+     *
+     * @param string $content The original email content.
+     */
+    $content = apply_filters( 'wp_mail_original_content', $content );
 
     if ( false !== stripos($content_transfer_encoding, "quoted-printable") ) {
@@ -195 +207 @@
     $content = trim($content);
 
-    $post_content = apply_filters('phone_content', $content);
+    /**
+     * Filter the content of the post submitted by email before saving.
+     *
+     * @since 1.2.0
+     *
+     * @param string $content The email content.
+     */
+    $post_content = apply_filters( 'phone_content', $content );
 
     $post_title = xmlrpc_getposttitle($content);
@@ -214 +233 @@
         continue;
 
-    do_action('publish_phone', $post_ID);
+    /**
+     * Fires after a post submitted by email is published.
+     *
+     * @since 1.2.0
+     *
+     * @param int $post_ID The post ID.
+     */
+    do_action( 'publish_phone', $post_ID );
 
     echo "\n<p>" . sprintf(__('<strong>Author:</strong> %s'), esc_html($post_author)) . '</p>';