Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
10/24/2013 12:08:59 AM (13 years ago)
Author:
boonebgorges
Message:

Improve inline docs in bp-activity-admin.php. See #5022

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/bp-activity/bp-activity-admin.php

    r7391 r7472  
    11<?php
    22/**
    3  * BuddyPress Activity component admin screen
    4  *
    5  * Props to WordPress core for the Comments admin screen, and its contextual help text,
    6  * on which this implementation is heavily based.
     3 * BuddyPress Activity component admin screen.
     4 *
     5 * Props to WordPress core for the Comments admin screen, and its contextual
     6 * help text, on which this implementation is heavily based.
    77 *
    88 * @package BuddyPress
    9  * @since BuddyPress (1.6)
     9 * @since BuddyPress (1.6.0)
    1010 * @subpackage Activity
    1111 */
    … …  
    2222
    2323/**
    24  * Registers the Activity component admin screen.
     24 * Register the Activity component admin screen.
    2525 *
    2626 * @since BuddyPress (1.6)
    … …  
    5050 * adds the Activity page to the array of these menu items.
    5151 *
    52  * @since BuddyPress (1.7)
     52 * @since BuddyPress (1.7.0)
    5353 *
    5454 * @param array $custom_menus The list of top-level BP menu items.
    … …  
    6767 * table row.
    6868 *
    69  * @since BuddyPress (1.6)
     69 * @since BuddyPress (1.6.0)
    7070 */
    7171function bp_activity_admin_reply() {
    … …  
    137137 * Handle save/update of screen options for the Activity component admin screen.
    138138 *
    139  * @since BuddyPress (1.6)
    140  *
    141  * @param string $value Will always be false unless another plugin filters it first.
     139 * @since BuddyPress (1.6.0)
     140 *
     141 * @param string $value Will always be false unless another plugin filters it
     142 *        first.
    142143 * @param string $option Screen option name.
    143144 * @param string $new_value Screen option form value.
    … …  
    159160 * Hide the advanced edit meta boxes by default, so we don't clutter the screen.
    160161 *
    161  * @since BuddyPress (1.6)
     162 * @since BuddyPress (1.6.0)
    162163 *
    163164 * @param WP_Screen $screen Screen identifier.
    … …  
    183184 *   - Catches POST and GET requests related to Activity
    184185 *
    185  * @since BuddyPress (1.6)
     186 * @since BuddyPress (1.6.0)
    186187 *
    187188 * @global object $bp BuddyPress global settings.
    … …  
    533534
    534535/**
    535  * Outputs the Activity component admin screens.
    536  *
    537  * @since BuddyPress (1.6)
     536 * Output the Activity component admin screens.
     537 *
     538 * @since BuddyPress (1.6.0)
    538539 */
    539540function bp_activity_admin() {
    … …  
    553554 * Display the single activity edit screen.
    554555 *
    555  * @since BuddyPress (1.6)
     556 * @since BuddyPress (1.6.0)
    556557 */
    557558function bp_activity_admin_edit() {
    … …  
    644645 * Status metabox for the Activity admin edit screen.
    645646 *
    646  * @since BuddyPress (1.6)
     647 * @since BuddyPress (1.6.0)
    647648 *
    648649 * @param object $item Activity item.
    … …  
    700701 * Primary link metabox for the Activity admin edit screen.
    701702 *
    702  * @since BuddyPress (1.6)
     703 * @since BuddyPress (1.6.0)
    703704 *
    704705 * @param object $item Activity item.
    … …  
    717718 * User ID metabox for the Activity admin edit screen.
    718719 *
    719  * @since BuddyPress (1.6)
     720 * @since BuddyPress (1.6.0)
    720721 *
    721722 * @param object $item Activity item.
    … …  
    733734 * Activity type metabox for the Activity admin edit screen
    734735 *
    735  * @since BuddyPress (1.6)
    736  *
    737  * @global object $bp BuddyPress global settings
    738  *
    739  * @param object $item Activity item
     736 * @since BuddyPress (1.6.0)
     737 *
     738 * @global object $bp BuddyPress global settings.
     739 *
     740 * @param object $item Activity item.
    740741 */
    741742function bp_activity_admin_edit_metabox_type( $item ) {
    … …  
    771772 * Primary item ID/Secondary item ID metabox for the Activity admin edit screen.
    772773 *
    773  * @since BuddyPress (1.6)
    774  *
    775  * @param object $item Activity item
     774 * @since BuddyPress (1.6.0)
     775 *
     776 * @param object $item Activity item.
    776777 */
    777778function bp_activity_admin_edit_metabox_itemids( $item ) {
    … …  
    793794 * Display the Activity admin index screen, which contains a list of all the activities.
    794795 *
    795  * @since BuddyPress (1.6)
    796  *
    797  * @global BP_Activity_List_Table $bp_activity_list_table Activity screen list table.
     796 * @since BuddyPress (1.6.0)
     797 *
     798 * @global BP_Activity_List_Table $bp_activity_list_table Activity screen list
     799 *         table.
    798800 * @global string $plugin_page The current plugin page.
    799801 */
    … …  
    926928
    927929        /**
    928          * What type of view is being displayed? e.g. "All", "Pending", "Approved", "Spam"...
    929          *
    930          * @since BuddyPress (1.6)
    931         */
     930         * What type of view is being displayed?
     931         *
     932         * e.g. "all", "pending", "approved", "spam"...
     933         *
     934         * @since BuddyPress (1.6.0)
     935         * @var string
     936         */
    932937        public $view = 'all';
    933938
    … …  
    935940         * How many activity items have been marked as spam.
    936941         *
    937          * @since BuddyPress (1.6)
     942         * @since BuddyPress (1.6.0)
     943         * @var int
    938944         */
    939945        public $spam_count = 0;
    … …  
    942948         * Store activity-to-user-ID mappings for use in the In Response To column.
    943949         *
    944          * @since BuddyPress (1.6)
     950         * @since BuddyPress (1.6.0)
     951         * @var array
    945952         */
    946953        protected $activity_user_id = array();
    … …  
    949956         * Constructor.
    950957         *
    951          * @since BuddyPress (1.6)
     958         * @since BuddyPress (1.6.0)
    952959         */
    953960        public function __construct() {
    … …  
    962969
    963970        /**
    964          * Handle filtering of data, sorting, pagination, and any other data-manipulation required prior to rendering.
    965          *
    966          * @since BuddyPress (1.6)
     971         * Handle filtering of data, sorting, pagination, and any other data manipulation prior to rendering.
     972         *
     973         * @since BuddyPress (1.6.0)
    967974         */
    968975        function prepare_items() {
    … …  
    10651072         * Get an array of all the columns on the page.
    10661073         *
    1067          * @since BuddyPress (1.6)
    1068          *
    1069          * @return array
     1074         * @since BuddyPress (1.6.0)
     1075         *
     1076         * @return array Column headers.
    10701077         */
    10711078        function get_column_info() {
    … …  
    10801087
    10811088        /**
    1082          * Displays a message on screen when no items are found (e.g. no search matches).
    1083          *
    1084          * @since BuddyPress (1.6)
     1089         * Display a message on screen when no items are found (e.g. no search matches).
     1090         *
     1091         * @since BuddyPress (1.6.0)
    10851092         */
    10861093        function no_items() {
    … …  
    10891096
    10901097        /**
    1091          * Outputs the Activity data table.
    1092          *
    1093          * @since BuddyPress (1.6)
     1098         * Output the Activity data table.
     1099         *
     1100         * @since BuddyPress (1.6.0)
    10941101        */
    10951102        function display() {
    … …  
    11211128
    11221129        /**
    1123          * Generates content for a single row of the table.
    1124          *
    1125          * @since BuddyPress (1.6)
    1126          *
    1127          * @param object $item The current item
     1130         * Generate content for a single row of the table.
     1131         *
     1132         * @since BuddyPress (1.6.0)
     1133         *
     1134         * @param object $item The current item.
    11281135         */
    11291136        function single_row( $item ) {
    … …  
    11461153         * Get the list of views available on this table (e.g. "all", "spam").
    11471154         *
    1148          * @since BuddyPress (1.6)
     1155         * @since BuddyPress (1.6.0)
    11491156         */
    11501157        function get_views() {
    … …  
    11631170         * Get bulk actions.
    11641171         *
    1165          * @since BuddyPress (1.6)
     1172         * @since BuddyPress (1.6.0)
    11661173         *
    11671174         * @return array Key/value pairs for the bulk actions dropdown.
    … …  
    11791186         * Get the table column titles.
    11801187         *
    1181          * @since BuddyPress (1.6)
     1188         * @since BuddyPress (1.6.0)
    11821189         *
    11831190         * @see WP_List_Table::single_row_columns()
    … …  
    11991206         * Currently, returns an empty array (no columns are sortable).
    12001207         *
    1201          * @since BuddyPress (1.6)
    1202          * @todo For this to work, BP_Activity_Activity::get() needs updating to supporting ordering by specific fields
     1208         * @since BuddyPress (1.6.0)
     1209         * @todo For this to work, BP_Activity_Activity::get() needs updating
     1210         *       to support ordering by specific fields.
    12031211         *
    12041212         * @return array The columns that can be sorted on the Activity screen.
    … …  
    12151223         * Markup for the "filter" part of the form (i.e. which activity type to display).
    12161224         *
    1217          * @since BuddyPress (1.6)
     1225         * @since BuddyPress (1.6.0)
    12181226         *
    12191227         * @param string $which 'top' or 'bottom'.
    … …  
    12481256         * Checkbox column markup.
    12491257         *
    1250          * @since BuddyPress (1.6)
     1258         * @since BuddyPress (1.6.0)
    12511259         *
    12521260         * @see WP_List_Table::single_row_columns()
    … …  
    12611269         * Author column markup.
    12621270         *
    1263          * @since BuddyPress (1.6)
     1271         * @since BuddyPress (1.6.0)
    12641272         *
    12651273         * @see WP_List_Table::single_row_columns()
    12661274         *
    1267          * @param array $item A singular item (one full row)
     1275         * @param array $item A singular item (one full row).
    12681276         */
    12691277        function column_author( $item ) {
    … …  
    12761284         * Called "comment" in the CSS so we can re-use some WP core CSS.
    12771285         *
    1278          * @since BuddyPress (1.6)
     1286         * @since BuddyPress (1.6.0)
    12791287         *
    12801288         * @see WP_List_Table::single_row_columns()
    1281          &
     1289         *
    12821290         * @param array $item A singular item (one full row).
    12831291         */
    … …  
    13501358         * "In response to" column markup.
    13511359         *
    1352          * @since BuddyPress (1.6)
     1360         * @since BuddyPress (1.6.0)
    13531361         *
    13541362         * @see WP_List_Table::single_row_columns()
    … …  
    13841392         * avoiding duplicate queries.
    13851393         *
    1386          * @since BuddyPress (1.6)
     1394         * @since BuddyPress (1.6.0)
    13871395         *
    13881396         * @param int $activity_id Activity ID to retrieve User ID for.
    … …  
    14221430         * items plus their comments. This method converts it to a flat array.
    14231431         *
    1424          * @since BuddyPress (1.6)
     1432         * @since BuddyPress (1.6.0)
    14251433         *
    14261434         * @param array $tree Source array.
Note: See TracChangeset for help on using the changeset viewer.