Changeset 1653

Show
Ignore:
Timestamp:
08/19/08 00:43:16 (3 months ago)
Author:
sambauers
Message:

Inline documentation changes for bb_mail()

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • trunk/bb-includes/pluggable.php

    r1652 r1653  
    512512 * process the request without any errors. 
    513513 * 
    514  * Using the two 'wp_mail_from' and 'wp_mail_from_name' hooks allow from 
     514 * Using the two 'bb_mail_from' and 'bb_mail_from_name' hooks allow from 
    515515 * creating a from address like 'Name <email@address.com>' when both are set. If 
    516  * just 'wp_mail_from' is set, then just the email address will be used with no 
     516 * just 'bb_mail_from' is set, then just the email address will be used with no 
    517517 * name. 
    518518 * 
    519519 * The default content type is 'text/plain' which does not allow using HTML. 
    520520 * However, you can set the content type of the email by using the 
    521  * 'wp_mail_content_type' filter. 
     521 * 'bb_mail_content_type' filter. 
    522522 * 
    523523 * The default charset is based on the charset used on the blog. The charset can 
    524  * be set using the 'wp_mail_charset' filter. 
     524 * be set using the 'bb_mail_charset' filter. 
    525525 * 
    526  * @since 1.2.1 
    527  * @uses apply_filters() Calls 'wp_mail' hook on an array of all of the parameters. 
    528  * @uses apply_filters() Calls 'wp_mail_from' hook to get the from email address. 
    529  * @uses apply_filters() Calls 'wp_mail_from_name' hook to get the from address name. 
    530  * @uses apply_filters() Calls 'wp_mail_content_type' hook to get the email content type. 
    531  * @uses apply_filters() Calls 'wp_mail_charset' hook to get the email charset 
    532  * @uses do_action_ref_array() Calls 'phpmailer_init' hook on the reference to 
     526 * @uses apply_filters() Calls 'bb_mail' hook on an array of all of the parameters. 
     527 * @uses apply_filters() Calls 'bb_mail_from' hook to get the from email address. 
     528 * @uses apply_filters() Calls 'bb_mail_from_name' hook to get the from address name. 
     529 * @uses apply_filters() Calls 'bb_mail_content_type' hook to get the email content type. 
     530 * @uses apply_filters() Calls 'bb_mail_charset' hook to get the email charset 
     531 * @uses do_action_ref_array() Calls 'bb_phpmailer_init' hook on the reference to 
    533532 *              phpmailer object. 
    534533 * @uses PHPMailer 
    535  * @ 
    536534 * 
    537535 * @param string $to Email address to send message