Skip to:
Content

bbPress.org

Changeset 4508


Ignore:
Timestamp:
11/24/2012 08:44:30 PM (14 years ago)
Author:
johnjamesjacoby
Message:

Extract:

  • Clean up bbp_parse_args() usages and inline documents.
  • Fixes #2056.
Location:
trunk/includes
Files:
10 edited

Legend:

Unmodified
Added
Removed

  • trunk/includes/common/functions.php

    r4500 r4508  
    431431function bbp_get_statistics( $args = '' ) {
    432432
    433         // Parse arguments
     433        // Parse arguments against default values
    434434        $r = bbp_parse_args( $args, array(
    435435                'count_users'           => true,
    … …  
    599599function bbp_filter_anonymous_post_data( $args = '' ) {
    600600
    601         // Parse arguments with default parameters
     601        // Parse arguments against default values
    602602        $r = bbp_parse_args( $args, array (
    603603                'bbp_anonymous_name'    => !empty( $_POST['bbp_anonymous_name']    ) ? $_POST['bbp_anonymous_name']    : false,
    … …  
    652652        global $wpdb;
    653653
     654        // Parse arguments against default values
    654655        $r = bbp_parse_args( $post_data, array(
    655656                'post_author'    => 0,

  • trunk/includes/common/template-tags.php

    r4496 r4508  
    10371037function bbp_wp_login_action( $args = '' ) {
    10381038
    1039         // Parse args with default parameters
     1039        // Parse arguments against default values
    10401040        $r = bbp_parse_args( $args, array(
    10411041                'action'  => '',
    … …  
    12481248                /** Arguments *********************************************************/
    12491249
     1250                // Parse arguments against default values
    12501251                $r = bbp_parse_args( $args, array(
    12511252                        'post_type'          => bbp_get_forum_post_type(),
    … …  
    15821583        function bbp_get_the_content( $args = array() ) {
    15831584
    1584                 // Parse arguments with default values
     1585                // Parse arguments against default values
    15851586                $r = bbp_parse_args( $args, array(
    15861587                        'context'       => 'topic',

  • trunk/includes/core/update.php

    r4487 r4508  
    159159function bbp_create_initial_content( $args = array() ) {
    160160
     161        // Parse arguments against default values
    161162        $r = bbp_parse_args( $args, array(
    162163                'forum_parent'  => 0,

  • trunk/includes/forums/functions.php

    r4501 r4508  
    14561456function bbp_update_forum( $args = '' ) {
    14571457
    1458         // Parse arguments with default values
     1458        // Parse arguments against default values
    14591459        $r = bbp_parse_args( $args, array(
    14601460                'forum_id'           => 0,

  • trunk/includes/forums/template-tags.php

    r4505 r4508  
    6969                $post_stati[] = bbp_get_hidden_status_id();
    7070
    71         // The default forum query for most circumstances
     71        // Parse arguments with default forum query for most circumstances
    7272        $bbp_f = bbp_parse_args( $args, array(
    7373                'post_type'      => bbp_get_forum_post_type(),
    … …  
    635635        }
    636636
    637         $defaults = array(
     637        // Parse arguments against default values
     638        $r = bbp_parse_args( $args, array(
    638639                'post_parent'    => 0,
    639640                'post_type'      => bbp_get_forum_post_type(),
    … …  
    642643                'orderby'        => 'menu_order',
    643644                'order'          => 'ASC'
    644         );
    645         $r = bbp_parse_args( $args, $defaults, 'forum_get_subforums' );
     645        ), 'forum_get_subforums' );
    646646        $r['post_parent'] = bbp_get_forum_id( $r['post_parent'] );
    647647
    … …  
    678678        $count = array();
    679679
    680         // Defaults and arguments
     680        // Parse arguments against default values
    681681        $r = bbp_parse_args( $args, array(
    682682                'before'            => '<ul class="bbp-forums-list">',
    … …  
    18211821        function bbp_get_single_forum_description( $args = '' ) {
    18221822
    1823                 // Parse arguments with default values
     1823                // Parse arguments against default values
    18241824                $r = bbp_parse_args( $args, array(
    18251825                        'forum_id'  => 0,

  • trunk/includes/replies/functions.php

    r4486 r4508  
    690690        if ( !empty( $anonymous_data ) && is_array( $anonymous_data ) ) {
    691691
    692                 // Always set at least these three values to empty
    693                 $defaults = array(
     692                // Parse arguments against default values
     693                $r = bbp_parse_args( $anonymous_data, array(
    694694                        'bbp_anonymous_name'    => '',
    695695                        'bbp_anonymous_email'   => '',
    696696                        'bbp_anonymous_website' => '',
    697                 );
    698                 $r = bbp_parse_args( $anonymous_data, $defaults, 'update_reply' );
     697                ), 'update_reply' );
    699698
    700699                // Update all anonymous metas
    … …  
    988987function bbp_update_reply_revision_log( $args = '' ) {
    989988
    990         // Parse arguments with default values
     989        // Parse arguments against default values
    991990        $r = bbp_parse_args( $args, array(
    992991                'reason'      => '',

  • trunk/includes/replies/template-tags.php

    r4507 r4508  
    9595        /** Setup *****************************************************************/
    9696
    97         // Parse arguments with default values
     97        // Parse arguments against default values
    9898        $r = bbp_parse_args( $args, $default, 'has_replies' );
    9999
    … …  
    10121012        function bbp_get_reply_author_link( $args = '' ) {
    10131013
    1014                 // Parse arguments with default values
     1014                // Parse arguments against default values
    10151015                $r = bbp_parse_args( $args, array(
    10161016                        'post_id'    => 0,
    … …  
    11961196        function bbp_get_reply_author_role( $args = array() ) {
    11971197
    1198                 // Parse arguments with default values
     1198                // Parse arguments against default values
    11991199                $r = bbp_parse_args( $args, array(
    12001200                        'reply_id' => 0,
    … …  
    14271427        function bbp_get_reply_admin_links( $args = '' ) {
    14281428
    1429                 // Parse arguments with default values
     1429                // Parse arguments against default values
    14301430                $r = bbp_parse_args( $args, array(
    14311431                        'id'     => 0,
    … …  
    15221522        function bbp_get_reply_edit_link( $args = '' ) {
    15231523
    1524                 // Parse arguments with default values
     1524                // Parse arguments against default values
    15251525                $r = bbp_parse_args( $args, array(
    15261526                        'id'           => 0,
    … …  
    16451645        function bbp_get_reply_trash_link( $args = '' ) {
    16461646
    1647                 // Parse arguments with default values
     1647                // Parse arguments against default values
    16481648                $r = bbp_parse_args( $args, array(
    16491649                        'id'           => 0,
    … …  
    17171717        function bbp_get_reply_spam_link( $args = '' ) {
    17181718               
    1719                 // Parse argmuments with default values
     1719                // Parse arguments against default values
    17201720                $r = bbp_parse_args( $args, array(
    17211721                        'id'           => 0,
    … …  
    17811781        function bbp_get_topic_split_link( $args = '' ) {
    17821782
    1783                 // Parse arguments with default values
     1783                // Parse arguments against default values
    17841784                $r = bbp_parse_args( $args, array(
    17851785                        'id'          => 0,

  • trunk/includes/topics/functions.php

    r4490 r4508  
    2929function bbp_insert_topic( $topic_data = array(), $topic_meta = array() ) {
    3030
    31         // Forum
    32         $default_topic = array(
     31        // Parse arguments against default values
     32        $topic_data = bbp_parse_args( $topic_data, array(
    3333                'post_parent'    => 0, // forum ID
    3434                'post_status'    => bbp_get_public_status_id(),
    … …  
    4040                'comment_status' => 'closed',
    4141                'menu_order'     => 0,
    42         );
    43 
    44         // Parse args
    45         $topic_data = bbp_parse_args( $topic_data, $default_topic, 'insert_topic' );
     42        ), 'insert_topic' );
    4643
    4744        // Insert topic
    … …  
    5249                return false;
    5350
    54         // Forum meta
    55         $default_meta = array(
     51        // Parse arguments against default values
     52        $topic_meta = bbp_parse_args( $topic_meta, array(
    5653                'author_ip'          => bbp_current_author_ip(),
    5754                'forum_id'           => 0,
    … …  
    6360                'last_active_id'     => $topic_id,
    6461                'last_active_time'   => get_post_field( 'post_date', $topic_id, 'db' ),
    65         );
    66 
    67         // Parse args
    68         $topic_meta = bbp_parse_args( $topic_meta, $default_meta, 'insert_topic_meta' );
     62        ), 'insert_topic_meta' );
    6963
    7064        // Insert topic meta
    … …  
    779773        if ( !empty( $anonymous_data ) && is_array( $anonymous_data ) ) {
    780774
    781                 // Always set at least these three values to empty
    782                 $defaults = array(
     775                // Parse arguments against default values
     776                $r = bbp_parse_args( $anonymous_data, array(
    783777                        'bbp_anonymous_name'    => '',
    784778                        'bbp_anonymous_email'   => '',
    785779                        'bbp_anonymous_website' => '',
    786                 );
    787                 $r = bbp_parse_args( $anonymous_data, $defaults, 'update_topic' );
     780                ), 'update_topic' );
    788781
    789782                // Update all anonymous metas
    … …  
    25572550function bbp_update_topic_revision_log( $args = '' ) {
    25582551
    2559         // Parse arguments with default values
     2552        // Parse arguments against default values
    25602553        $r = bbp_parse_args( $args, array(
    25612554                'reason'      => '',

  • trunk/includes/topics/template-tags.php

    r4506 r4508  
    122122        /** Setup *****************************************************************/
    123123
    124         // Parse arguments with default values
     124        // Parse arguments against default values
    125125        $r = bbp_parse_args( $args, $default, 'has_topics' );
    126126
    … …  
    735735                global $wp_rewrite;
    736736
     737                // Parse arguments against default values
    737738                $r = bbp_parse_args( $args, array(
    738739                        'topic_id' => bbp_get_topic_id(),
    … …  
    21772178                        return;
    21782179
    2179                 $defaults = array (
     2180                // Parse arguments against default values
     2181                $r = bbp_parse_args( $args, array (
    21802182                        'id'     => bbp_get_topic_id(),
    21812183                        'before' => '<span class="bbp-admin-links">',
    … …  
    21832185                        'sep'    => ' | ',
    21842186                        'links'  => array()
    2185                 );
    2186                 $r = bbp_parse_args( $args, $defaults, 'get_topic_admin_links' );
     2187                ), 'get_topic_admin_links' );
    21872188
    21882189                if ( !current_user_can( 'edit_topic', $r['id'] ) )
    … …  
    25132514        function bbp_get_topic_stick_link( $args = '' ) {
    25142515
    2515                 // Parse argmuntes against default values
     2516                // Parse arguments against default values
    25162517                $r = bbp_parse_args( $args, array(
    25172518                        'id'           => 0,
    … …  
    28192820
    28202821                // Get current topic id
    2821                 $topic_id = bbp_get_topic_id( $topic_id );
     2822                $topic_id = bbp_get_topic_id( $r['topic_id'] );
    28222823
    28232824                // Post value is passed
    … …  
    29062907        function bbp_get_single_topic_description( $args = '' ) {
    29072908
    2908                 // Parse argmuents against default values
     2909                // Parse arguments against default values
    29092910                $r = bbp_parse_args( $args, array(
    29102911                        'topic_id'  => 0,

  • trunk/includes/users/template-tags.php

    r4498 r4508  
    494494                        $args = array( 'text' => $args );
    495495
     496                // Parse arguments against default values
    496497                $r = bbp_parse_args( $args, array(
    497498                        'text'   => __( 'Admin', 'bbpress' ),
    … …  
    531532                // Used as post id
    532533                $post_id = is_numeric( $args ) ? (int) $args : 0;
    533                 $r       = bbp_parse_args( $args, array(
     534               
     535                // Parse arguments against default values
     536                $r = bbp_parse_args( $args, array(
    534537                        'post_id' => $post_id,
    535538                        'before'  => '<span class="bbp-author-ip">(',
    … …  
    813816                        return;
    814817
     818                // Parse arguments against default values
    815819                $r = bbp_parse_args( $args, array(
    816820                        'subscribe'   => __( 'Subscribe',   'bbpress' ),
    … …  
    13391343
    13401344                $post_id = is_numeric( $args ) ? (int) $args : 0;
    1341                 $r       = bbp_parse_args( $args, array(
     1345
     1346                // Parse arguments against default values
     1347                $r = bbp_parse_args( $args, array(
    13421348                        'post_id'    => $post_id,
    13431349                        'link_title' => '',
    … …  
    14251431function bbp_user_can_view_forum( $args = '' ) {
    14261432
    1427         // Default arguments
     1433        // Parse arguments against default values
    14281434        $r = bbp_parse_args( $args, array(
    14291435                'user_id'         => bbp_get_current_user_id(),
    … …  
    15921598                $post__not_in = implode( ',', $forum_ids );
    15931599
    1594         $defaults = array(
     1600        // Parse arguments against default values
     1601        $r = bbp_parse_args( $args, array(
    15951602                'post_type'   => bbp_get_forum_post_type(),
    15961603                'post_status' => bbp_get_public_status_id(),
    15971604                'numberposts' => -1,
    15981605                'exclude'     => $post__not_in
    1599         );
    1600         $r = bbp_parse_args( $args, $defaults, 'get_forums_for_current_user' );
     1606        ), 'get_forums_for_current_user' );
    16011607
    16021608        // Get the forums
Note: See TracChangeset for help on using the changeset viewer.