Skip to:
Content

bbPress.org

Changeset 7380 for trunk/src/bbpress.php


Ignore:
Timestamp:
12/05/2025 02:27:53 AM (8 months ago)
Author:
johnjamesjacoby
Message:

Tools - Code Improvement: docs & code formatting improvements.

Props johnjamesjacoby, noruzzaman.

Fixes #3659.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bbpress.php

    r7378 r7380  
    22
    33/**
    4  * The bbPress Plugin
     4 * The bbPress Plugin.
    55 *
    66 * bbPress is forum software with a twist from the creators of WordPress.
    … …  
    3333if ( ! class_exists( 'bbPress' ) ) :
    3434/**
    35  * Main bbPress Class
     35 * Main bbPress Class.
    3636 *
    3737 * "Word hard. Stay bumble."
    … …  
    5858
    5959        /**
    60          * @var mixed False when not logged in; WP_User object when logged in
     60         * @var mixed False when not logged in; WP_User object when logged in.
    6161         */
    6262        public $current_user = false;
    … …  
    6868
    6969        /**
    70          * @var array Topic views
     70         * @var array Topic views.
    7171         */
    7272        public $views = array();
    7373
    7474        /**
    75          * @var array Overloads get_option()
     75         * @var array Overloads get_option().
    7676         */
    7777        public $options = array();
    7878
    7979        /**
    80          * @var array Storage of options not in the database
     80         * @var array Storage of options not in the database.
    8181         */
    8282        public $not_options = array();
    8383
    8484        /**
    85          * @var array Overloads get_user_meta()
     85         * @var array Overloads get_user_meta().
    8686         */
    8787        public $user_options = array();
    8888
    8989        /**
    90          * @var array Dynamically initialized user roles
     90         * @var array Dynamically initialized user roles.
    9191         */
    9292        public $roles = array();
    … …  
    9595
    9696        /**
    97          * Main bbPress Instance
    98          *
    99          * bbPress is fun
    100          * Please load it only one time
    101          * For this, we thank you
     97         * Main bbPress Instance.
     98         *
     99         * bbPress is fun.
     100         * Please load it only one time.
     101         * For this, we thank you.
    102102         *
    103103         * Insures that only one instance of bbPress exists in memory at any one
    … …  
    108108         * @staticvar object $instance
    109109         * @see bbpress()
    110          * @return bbPress The one true bbPress
     110         * @return bbPress The one true bbPress.
    111111         */
    112112        public static function instance() {
    … …  
    143143
    144144        /**
    145          * A dummy magic method to prevent bbPress from being cloned
     145         * A dummy magic method to prevent bbPress from being cloned.
    146146         *
    147147         * @since 2.0.0 bbPress (r2464)
    … …  
    152152
    153153        /**
    154          * A dummy magic method to prevent bbPress from being unserialized
     154         * A dummy magic method to prevent bbPress from being unserialized.
    155155         *
    156156         * @since 2.0.0 bbPress (r2464)
    … …  
    161161
    162162        /**
    163          * Magic method for checking the existence of a certain custom field
     163         * Magic method for checking the existence of a certain custom field.
    164164         *
    165165         * @since 2.1.0 bbPress (r3951)
    … …  
    170170
    171171        /**
    172          * Magic method for getting bbPress variables
     172         * Magic method for getting bbPress variables.
    173173         *
    174174         * @since 2.1.0 bbPress (r3951)
    … …  
    181181
    182182        /**
    183          * Magic method for setting bbPress variables
     183         * Magic method for setting bbPress variables.
    184184         *
    185185         * @since 2.1.0 bbPress (r3951)
    … …  
    190190
    191191        /**
    192          * Magic method for unsetting bbPress variables
     192         * Magic method for unsetting bbPress variables.
    193193         *
    194194         * @since 2.3.0 bbPress (r4628)
    … …  
    201201
    202202        /**
    203          * Magic method to prevent notices and errors from invalid method calls
     203         * Magic method to prevent notices and errors from invalid method calls.
    204204         *
    205205         * @since 2.2.0 bbPress (r4252)
    … …  
    325325
    326326        /**
    327          * Include required files
     327         * Include required files.
    328328         *
    329329         * @since 2.0.0 bbPress (r2626)
    … …  
    402402
    403403        /**
    404          * Setup the default hooks and actions
     404         * Setup the default hooks and actions.
    405405         *
    406406         * @since 2.0.0 bbPress (r2644)
    … …  
    450450
    451451        /**
    452          * Register bundled theme packages
     452         * Register bundled theme packages.
    453453         *
    454454         * Note that since we currently have complete control over bbp-themes and
    … …  
    518518
    519519        /**
    520          * Setup the post types for forums, topics and replies
     520         * Setup the post types for forums, topics and replies.
    521521         *
    522522         * @since 2.0.0 bbPress (r2597)
    … …  
    613613
    614614        /**
    615          * Register the post statuses used by bbPress
     615         * Register the post statuses used by bbPress.
    616616         *
    617617         * We do some manipulation of the 'trash' status so trashed topics and
    … …  
    694694
    695695                /**
    696                  * Trash fix
     696                 * Trash fix.
    697697                 *
    698698                 * We need to remove the internal arg and change that to
    … …  
    718718
    719719        /**
    720          * Register the topic tag and forum moderator taxonomies
     720         * Register the topic tag and forum moderator taxonomies.
    721721         *
    722722         * @since 2.0.0 bbPress (r2464) Added bbp_get_topic_tag_tax_id() taxonomy
    … …  
    748748
    749749        /**
    750          * Register the bbPress views
     750         * Register the bbPress views.
    751751         *
    752752         * @since 2.0.0 bbPress (r2789)
    … …  
    789789
    790790        /**
    791          * Register the bbPress shortcodes
     791         * Register the bbPress shortcodes.
    792792         *
    793793         * @since 2.0.0 bbPress (r3031)
    … …  
    798798
    799799        /**
    800          * Register bbPress meta-data
    801          *
    802          * Counts added in 2.6.0 to avoid negative values
     800         * Register bbPress meta-data.
     801         *
     802         * Counts added in 2.6.0 to avoid negative values.
    803803         *
    804804         * @since 2.6.0 bbPress (r6300)
    … …  
    870870
    871871        /**
    872          * Setup the currently logged-in user
     872         * Setup the currently logged-in user.
    873873         *
    874874         * @since 2.0.0 bbPress (r2697)
    … …  
    879879
    880880        /**
    881          * Setup the user engagements strategy
     881         * Setup the user engagements strategy.
    882882         *
    883883         * @since 2.6.0 bbPress (r6875)
    … …  
    894894
    895895        /**
    896          * Initialize forum-specific roles
     896         * Initialize forum-specific roles.
    897897         *
    898898         * @since 2.6.0
    … …  
    920920
    921921        /**
    922          * Add the bbPress-specific rewrite tags
     922         * Add the bbPress-specific rewrite tags.
    923923         *
    924924         * @since 2.0.0 bbPress (r2753)
Note: See TracChangeset for help on using the changeset viewer.