![(please configure the [header_logo] section in trac.ini)](/chrome/site/your_project_logo.png){kind=logo}
Changeset 7444 for trunk/bp-core/bp-core-classes.php
- Timestamp:
- 10/19/2013 09:58:33 AM (13 years ago)
- File:
-
- 1 edited
-
trunk/bp-core/bp-core-classes.php (modified) (58 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/bp-core/bp-core-classes.php
r7427 r7444 1 1 <?php 2 2 /** 3 * Core component classes 3 * Core component classes. 4 4 * 5 5 * @package BuddyPress … … 11 11 12 12 /** 13 * BuddyPress User Query class 13 * BuddyPress User Query class. 14 14 * 15 15 * Used for querying users in a BuddyPress context, in situations where … … 17 17 * etc. 18 18 * 19 * Accepted parameters: 20 * type - Determines sort order. Select from 'newest', 'active', 21 * 'online', 'random', 'popular', 'alphabetical' 22 * per_page - Number of results to return 23 * page - Page offset (together with per_page) 24 * user_id - Pass a single numeric user id to limit results to 25 * friends of that user. Requires the Friends component 26 * search_terms - Terms to search by. Search happens across xprofile 27 * fields. Requires XProfile component 28 * include - An array or comma-separated list of user ids. Results 29 * will be limited to users in this list 30 * exclude - An array or comma-separated list of user ids. Results 31 * will not include any users in this list 32 * user_ids - An array or comma-separated list of user ids. When 33 * this parameter is passed, it will override all other 34 * parameters; BP User objects will be constructed using 35 * these IDs only 36 * meta_key - Limit results to users that have usermeta associated 37 * with this meta_key. Usually used with meta_value 38 * meta_value - When used with meta_key, limits results to users whose 39 * usermeta value associated with meta_key matches 40 * meta_value 41 * populate_extras - Boolean. True if you want to fetch extra metadata about 42 * returned users, such as total group and friend counts 43 * count_total - Determines how BP_User_Query will do a count of total 44 * users matching the other filter criteria. Default value 45 * is 'count_query', which does a separate SELECT COUNT 46 * query to determine the total. 'sql_count_found_rows' 47 * uses SQL_COUNT_FOUND_ROWS and SELECT FOUND_ROWS(). Pass 48 * an empty string to skip the total user count query. 19 * @since BuddyPress (1.7.0) 49 20 * 50 * @since BuddyPress (1.7) 21 * @param array $query { 22 * Query arguments. All items are optional. 23 * @type string $type Determines sort order. Select from 'newest', 'active', 24 * 'online', 'random', 'popular', 'alphabetical'. Default: 'newest'. 25 * @type int $per_page Number of results to return. Default: 0 (no limit). 26 * @type int $page Page offset (together with $per_page). Default: 0 (no 27 * limit). 28 * @type int $user_id ID of a user. If present, and if the friends 29 * component is activated, results will be limited to the friends of 30 * that user. Default: 0. 31 * @type string|bool $search_terms Terms to search by. Search happens 32 * across xprofile fields. Requires XProfile component. 33 * Default: false. 34 * @type array|string|bool $include An array or comma-separated list of 35 * user IDs to which query should be limited. 36 * Default: false. 37 * @type array|string|bool $exclude An array or comma-separated list of 38 * user IDs that will be excluded from query results. Default: false. 39 * @type array|string|bool $user_ids An array or comma-separated list of 40 * IDs corresponding to the users that should be returned. When this 41 * parameter is passed, it will override all others; BP User objects 42 * will be constructed using these IDs only. Default: false. 43 * @type string|bool $meta_key Limit results to users that have usermeta 44 * associated with this meta_key. Usually used with $meta_value. 45 * Default: false. 46 * @type string|bool $meta_value When used with $meta_key, limits results 47 * to users whose usermeta value associated with $meta_key matches 48 * $meta_value. Default: false. 49 * @type bool $populate_extras True if you want to fetch extra metadata 50 * about returned users, such as total group and friend counts. 51 * @type string $count_total Determines how BP_User_Query will do a count 52 * of total users matching the other filter criteria. Default value 53 * is 'count_query', which does a separate SELECT COUNT query to 54 * determine the total. 'sql_count_found_rows' uses 55 * SQL_COUNT_FOUND_ROWS and SELECT FOUND_ROWS(). Pass an empty string 56 * to skip the total user count query. 57 * } 51 58 */ 52 59 class BP_User_Query { … … 55 62 56 63 /** 57 * Unaltered params as passed to the constructor 58 * 59 * @since BuddyPress (1.8 )64 * Unaltered params as passed to the constructor. 65 * 66 * @since BuddyPress (1.8.0) 60 67 * @var array 61 68 */ … … 63 70 64 71 /** 65 * Array of variables to query with 66 * 67 * @since BuddyPress (1.7 )72 * Array of variables to query with. 73 * 74 * @since BuddyPress (1.7.0) 68 75 * @var array 69 76 */ … … 71 78 72 79 /** 73 * List of found users and their respective data 74 * 75 * @ since BuddyPress (1.7)76 * @ access public To allow components to manipulate them80 * List of found users and their respective data. 81 * 82 * @access public To allow components to manipulate them. 83 * @since BuddyPress (1.7.0) 77 84 * @var array 78 85 */ … … 80 87 81 88 /** 82 * Total number of found users for the current query 83 * 84 * @ since BuddyPress (1.7)85 * @ access public To allow components to manipulate it89 * Total number of found users for the current query. 90 * 91 * @access public To allow components to manipulate it. 92 * @since BuddyPress (1.7.0) 86 93 * @var int 87 94 */ … … 89 96 90 97 /** 91 * List of found user ID 's92 * 93 * @ since BuddyPress (1.7)94 * @ access public To allow components to manipulate it98 * List of found user IDs. 99 * 100 * @access public To allow components to manipulate it. 101 * @since BuddyPress (1.7.0) 95 102 * @var array 96 103 */ … … 98 105 99 106 /** 100 * SQL clauses for the user ID query 101 * 102 * @ since BuddyPress (1.7)103 * @ access public To allow components to manipulate it104 * @var array ()107 * SQL clauses for the user ID query. 108 * 109 * @access public To allow components to manipulate it. 110 * @since BuddyPress (1.7.0) 111 * @var array 105 112 */ 106 113 public $uid_clauses = array(); 107 114 108 115 /** 109 * SQL database column name to order by 110 * 111 * @since BuddyPress (1.7 )116 * SQL database column name to order by. 117 * 118 * @since BuddyPress (1.7.0) 112 119 * @var string 113 120 */ … … 117 124 * Standard response when the query should not return any rows. 118 125 * 119 * @since BuddyPress (1.7)120 126 * @access protected 127 * @since BuddyPress (1.7.0) 121 128 * @var string 122 129 */ … … 127 134 128 135 /** 129 * Constructor 130 * 131 * @since BuddyPress (1.7 )132 * 133 * @param string|array $query The query variables136 * Constructor. 137 * 138 * @since BuddyPress (1.7.0) 139 * 140 * @param string|array $query See {@link BP_User_Query}. 134 141 */ 135 142 public function __construct( $query = null ) { … … 184 191 185 192 /** 186 * Allow extending classes to set up action/filter hooks 193 * Allow extending classes to set up action/filter hooks. 187 194 * 188 195 * When extending BP_User_Query, you may need to use some of its … … 193 200 * your own class if you need a place where your extending class can 194 201 * add its hooks early in the query-building process. See 195 * BP_Group_Member_Query::setup_hooks()for an example.196 * 197 * @since BuddyPress (1.8 )202 * {@link BP_Group_Member_Query::setup_hooks()} for an example. 203 * 204 * @since BuddyPress (1.8.0) 198 205 */ 199 206 public function setup_hooks() {} 200 207 201 208 /** 202 * Prepare the query for user_ids 203 * 204 * @since BuddyPress (1.7 )209 * Prepare the query for user_ids. 210 * 211 * @since BuddyPress (1.7.0) 205 212 */ 206 213 public function prepare_user_ids_query() { … … 403 410 404 411 /** 412 * Query for IDs of users that match the query parameters. 413 * 405 414 * Perform a database query to specifically get only user IDs, using 406 415 * existing query variables set previously in the constructor. … … 408 417 * Also used to quickly perform user total counts. 409 418 * 410 * @since BuddyPress (1.7 )419 * @since BuddyPress (1.7.0) 411 420 */ 412 421 public function do_user_ids_query() { … … 431 440 432 441 /** 433 * Perform a database query using the WP_User_Query() object, using existing 434 * fields, variables, and user ID's set previously in this class. 435 * 436 * @since BuddyPress (1.7) 442 * Use WP_User_Query() to pull data for the user IDs retrieved in the main query. 443 * 444 * @since BuddyPress (1.7.0) 437 445 */ 438 446 public function do_wp_user_query() { … … 468 476 469 477 /** 470 * Fetch es the ids of users to put in the IN clause of the main query478 * Fetch the IDs of users to put in the IN clause of the main query. 471 479 * 472 480 * By default, returns the value passed to it … … 474 482 * standalone method means that extending classes can override the 475 483 * logic, parsing together their own user_id limits with the 'include' 476 * ids passed to the class constructor. See BP_Group_Member_Query for 477 * an example. 478 * 479 * @since BuddyPress (1.8) 480 * @param array Sanitized array of user ids, as passed to the 'include' 481 * parameter of the class constructor 484 * ids passed to the class constructor. See {@link BP_Group_Member_Query} 485 * for an example. 486 * 487 * @since BuddyPress (1.8.0) 488 * 489 * @param array Sanitized array of user IDs, as passed to the 'include' 490 * parameter of the class constructor. 482 491 * @return array The list of users to which the main query should be 483 * limited492 * limited. 484 493 */ 485 494 public function get_include_ids( $include = array() ) { … … 489 498 /** 490 499 * Perform a database query to populate any extra metadata we might need. 500 * 491 501 * Different components will hook into the 'bp_user_query_populate_extras' 492 502 * action to loop in the things they want. 493 503 * 494 * @since BuddyPress (1.7) 495 * 496 * @global BuddyPress $bp 497 * @global WPDB $wpdb 498 * @return 504 * @since BuddyPress (1.7.0) 505 * 506 * @global BuddyPress $bp Global BuddyPress settings object. 507 * @global WPDB $wpdb Global WordPress database access object. 499 508 */ 500 509 public function populate_extras() { … … 606 615 607 616 /** 617 * Fetch data about a BuddyPress user. 618 * 608 619 * BP_Core_User class can be used by any component. It will fetch useful 609 620 * details for any user when provided with a user_id. … … 615 626 * $user_status = $user->status; 616 627 * etc. 617 *618 * @package BuddyPress Core619 628 */ 620 629 class BP_Core_User { … … 714 723 * Profile information for the specific user. 715 724 * 716 * @since BuddyPress (1.2 )725 * @since BuddyPress (1.2.0) 717 726 * @var array 718 727 */ … … 724 733 * Class constructor. 725 734 * 726 * @param integer $user_id The ID for the user 727 * @param boolean $populate_extras Whether to fetch extra information such as group/friendship counts or not. 735 * @param integer $user_id The ID for the user being queried. 736 * @param bool $populate_extras Whether to fetch extra information 737 * such as group/friendship counts or not. Default: false. 728 738 */ 729 739 public function __construct( $user_id, $populate_extras = false ) { … … 738 748 } 739 749 740 /** Private Methods *******************************************************/741 742 750 /** 743 751 * Populate the instantiated class with data based on the User ID provided. 744 752 * 745 * @uses bp_core_get_userurl() Returns the URL with no HTML markup for a user based on their user id 746 * @uses bp_core_get_userlink() Returns a HTML formatted link for a user with the user's full name as the link text 747 * @uses bp_core_get_user_email() Returns the email address for the user based on user ID 748 * @uses bp_get_user_meta() BP function returns the value of passed usermeta name from usermeta table 753 * @uses bp_core_get_userurl() Returns the URL with no HTML markup for 754 * a user based on their user id. 755 * @uses bp_core_get_userlink() Returns a HTML formatted link for a 756 * user with the user's full name as the link text. 757 * @uses bp_core_get_user_email() Returns the email address for the 758 * user based on user ID. 759 * @uses bp_get_user_meta() BP function returns the value of passed 760 * usermeta name from usermeta table. 749 761 * @uses bp_core_fetch_avatar() Returns HTML formatted avatar for a user 750 * @uses bp_profile_last_updated_date() Returns the last updated date for a user. 762 * @uses bp_profile_last_updated_date() Returns the last updated date 763 * for a user. 751 764 */ 752 765 public function populate() { … … 795 808 } 796 809 810 /** 811 * Fetch xprofile data for the current user. 812 * 813 * @see BP_XProfile_ProfileData::get_all_for_user() for description of 814 * return value. 815 * 816 * @return array See {@link BP_XProfile_Profile_Data::get_all_for_user()}. 817 */ 797 818 public function get_profile_data() { 798 819 return BP_XProfile_ProfileData::get_all_for_user( $this->id ); … … 801 822 /** Static Methods ********************************************************/ 802 823 824 /** 825 * Get a list of users that match the query parameters. 826 * 827 * Since BuddyPress 1.7, use {@link BP_User_Query} instead. 828 * 829 * @deprecated 1.7.0 Use {@link BP_User_Query}. 830 * 831 * @see BP_User_Query for a description of parameters, most of which 832 * are used there in the same way. 833 * 834 * @param string $type See {@link BP_User_Query}. 835 * @param int $limit See {@link BP_User_Query}. Default: 0. 836 * @param int $page See {@link BP_User_Query}. Default: 1. 837 * @param int $user_id See {@link BP_User_Query}. Default: 0. 838 * @param mixed $include See {@link BP_User_Query}. Default: false. 839 * @param string|bool $search_terms See {@link BP_User_Query}. 840 * Default: false. 841 * @param bool $populate_extras See {@link BP_User_Query}. 842 * Default: true. 843 * @param mixed $exclude See {@link BP_User_Query}. Default: false. 844 * @param string|bool $meta_key See {@link BP_User_Query}. 845 * Default: false. 846 * @param string|bool $meta_value See {@link BP_User_Query}. 847 * Default: false. 848 * @return array { 849 * @type int $total_users Total number of users matched by query 850 * params. 851 * @type array $paged_users The current page of users matched by 852 * query params. 853 * } 854 */ 803 855 public static function get_users( $type, $limit = 0, $page = 1, $user_id = 0, $include = false, $search_terms = false, $populate_extras = true, $exclude = false, $meta_key = false, $meta_value = false ) { 804 856 global $wpdb, $bp; … … 976 1028 977 1029 /** 978 * Fetches the user details for all the users who username starts with the letter given. 979 * 980 * @global BuddyPress $bp The one true BuddyPress instance 981 * @global wpdb $wpdb WordPress database object 1030 * Fetch the details for all users whose usernames start with the given letter. 1031 * 1032 * @global BuddyPress $bp The one true BuddyPress instance. 1033 * @global wpdb $wpdb WordPress database object. 1034 * 982 1035 * @param string $letter The letter the users names are to start with. 983 * @param integer $limit The number of users we wish to retrive. 984 * @param integer $page The page number we are currently on, used in conjunction with $limit to get the start position for the limit. 985 * @param boolean $populate_extras Populate extra user fields? 986 * @param string $exclude Comma-separated IDs of users whose results aren't to be fetched. 1036 * @param int $limit The number of users we wish to retrive. 1037 * @param int $page The page number we are currently on, used in 1038 * conjunction with $limit to get the start position for the 1039 * limit. 1040 * @param bool $populate_extras Populate extra user fields? 1041 * @param string $exclude Comma-separated IDs of users whose results 1042 * aren't to be fetched. 987 1043 * @return mixed False on error, otherwise associative array of results. 988 * @static989 1044 */ 990 1045 public static function get_users_by_letter( $letter, $limit = null, $page = 1, $populate_extras = true, $exclude = '' ) { … … 1043 1098 1044 1099 /** 1045 * Get details of specific users from the database 1046 * 1047 * @global wpdb $wpdb WordPress database object 1048 * @param array $user_ids The user IDs of the users who we wish to fetch information on. 1049 * @param integer $limit The limit of results we want. 1050 * @param integer $page The page we are on for pagination. 1051 * @param boolean $populate_extras Populate extra user fields? 1052 * @return array Associative array 1053 * @static 1100 * Get details of specific users from the database. 1101 * 1102 * Use {@link BP_User_Query} with the 'user_ids' param instead. 1103 * 1104 * @global wpdb $wpdb WordPress database object. 1105 * @param array $user_ids The user IDs of the users who we wish to 1106 * fetch information on. 1107 * @param int $limit The limit of results we want. 1108 * @param int $page The page we are on for pagination. 1109 * @param bool $populate_extras Populate extra user fields? 1110 * @return array Associative array. 1054 1111 */ 1055 1112 public static function get_specific_users( $user_ids, $limit = null, $page = 1, $populate_extras = true ) { … … 1088 1145 * Find users who match on the value of an xprofile data. 1089 1146 * 1090 * @global BuddyPress $bp The one true BuddyPress instance 1091 * @global wpdb $wpdb WordPress database object 1092 * @param string $search_terms The terms to search the profile table value column for. 1147 * @global BuddyPress $bp The one true BuddyPress instance. 1148 * @global wpdb $wpdb WordPress database object. 1149 * 1150 * @param string $search_terms The terms to search the profile table 1151 * value column for. 1093 1152 * @param integer $limit The limit of results we want. 1094 1153 * @param integer $page The page we are on for pagination. 1095 1154 * @param boolean $populate_extras Populate extra user fields? 1096 * @return array Associative array 1097 * @static 1155 * @return array Associative array. 1098 1156 */ 1099 1157 public static function search_users( $search_terms, $limit = null, $page = 1, $populate_extras = true ) { … … 1131 1189 * Accepts multiple user IDs to fetch data for. 1132 1190 * 1133 * @global BuddyPress $bp The one true BuddyPress instance 1134 * @global wpdb $wpdb WordPress database object 1135 * @param array $paged_users an array of stdClass containing the users 1136 * @param string $user_ids the user ids to select information about 1137 * @param string $type the type of fields we wish to get 1191 * @global BuddyPress $bp The one true BuddyPress instance. 1192 * @global wpdb $wpdb WordPress database object. 1193 * 1194 * @param array $paged_users An array of stdClass containing the users. 1195 * @param string $user_ids The user ids to select information about. 1196 * @param string $type The type of fields we wish to get. 1138 1197 * @return mixed False on error, otherwise associative array of results. 1139 * @static1140 1198 */ 1141 1199 public static function get_user_extras( &$paged_users, &$user_ids, $type = false ) { … … 1217 1275 * Get WordPress user details for a specified user. 1218 1276 * 1219 * @global wpdb $wpdb WordPress database object 1220 * @param integer $user_id User ID1221 * @ return array Associative array1222 * @ static1277 * @global wpdb $wpdb WordPress database object. 1278 * 1279 * @param integer $user_id User ID. 1280 * @return array Associative array. 1223 1281 */ 1224 1282 public static function get_core_userdata( $user_id ) { … … 1468 1526 1469 1527 /** 1470 * BP_Button1528 * API to create BuddyPress buttons. 1471 1529 * 1472 * API to create BuddyPress buttons1530 * @since BuddyPress (1.2.6) 1473 1531 * 1474 * component: Which component this button is for 1475 * must_be_logged_in: Button only appears for logged in users 1476 * block_self: Button will not appear when viewing your own profile. 1477 * wrapper: div|span|p|li|false for no wrapper 1478 * wrapper_id: The DOM ID of the button wrapper 1479 * wrapper_class: The DOM class of the button wrapper 1480 * link_href: The destination link of the button 1481 * link_title: Title of the button 1482 * link_id: The DOM ID of the button 1483 * link_class: The DOM class of the button 1484 * link_rel: The DOM rel of the button 1485 * link_text: The text of the button 1486 * contents: The contents of the button 1487 * 1488 * @package BuddyPress Core 1489 * @since BuddyPress (1.2.6) 1532 * @param array $args { 1533 * Array of arguments. 1534 * @type string $id String describing the button type. 1535 * @type string $component The name of the component the button belongs to. 1536 * Default: 'core'. 1537 * @type bool $must_be_logged_in Optional. Does the user need to be logged 1538 * in to see this button? Default: true. 1539 * @type bool $block_self Optional. True if the button should be hidden 1540 * when a user is viewing his own profile. Default: true. 1541 * @type string|bool $wrapper Optional. HTML element type that should wrap 1542 * the button: 'div', 'span', 'p', or 'li'. False for no wrapper at 1543 * all. Default: 'div'. 1544 * @type string $wrapper_id Optional. DOM ID of the button wrapper element. 1545 * Default: ''. 1546 * @type string $wrapper_class Optional. DOM class of the button wrapper 1547 * element. Default: ''. 1548 * @type string $link_href Optional. Destination link of the button. 1549 * Default: ''. 1550 * @type string $link_class Optional. DOM class of the button. Default: ''. 1551 * @type string $link_id Optional. DOM ID of the button. Default: ''. 1552 * @type string $link_rel Optional. DOM 'rel' attribute of the button. 1553 * Default: ''. 1554 * @type string $link_title Optional. Title attribute of the button. 1555 * Default: ''. 1556 * @type string $link_text Optional. Text to appear on the button. 1557 * Default: ''. 1558 * } 1490 1559 */ 1491 1560 class BP_Button { … … 1494 1563 1495 1564 /** 1496 * The button ID 1497 * 1498 * @var integer1565 * The button ID. 1566 * 1567 * @var string 1499 1568 */ 1500 1569 public $id = ''; 1501 1570 1502 1571 /** 1503 * The component name thatbutton belongs to.1572 * The name of the component that the button belongs to. 1504 1573 * 1505 1574 * @var string … … 1510 1579 * Does the user need to be logged in to see this button? 1511 1580 * 1512 * @var bool ean1581 * @var bool 1513 1582 */ 1514 1583 public $must_be_logged_in = true; 1515 1584 1516 1585 /** 1517 * True or false if the button should not be displayed while viewing your 1518 * own profile. 1519 * 1520 * @var boolean 1586 * Whether the button should be hidden when viewing your own profile. 1587 * 1588 * @var bool 1521 1589 */ 1522 1590 public $block_self = true; … … 1525 1593 1526 1594 /** 1527 * What type of DOM element to use for a wrapper. 1528 * 1529 * 1530 * @var mixed div|span|p|li, or false for no wrapper 1595 * The type of DOM element to use for a wrapper. 1596 * 1597 * @var string|bool 'div', 'span', 'p', 'li', or false for no wrapper. 1531 1598 */ 1532 1599 public $wrapper = 'div'; 1533 1600 1534 1601 /** 1535 * The DOM class of the button wrapper 1602 * The DOM class of the button wrapper. 1536 1603 * 1537 1604 * @var string … … 1540 1607 1541 1608 /** 1542 * The DOM ID of the button wrapper 1609 * The DOM ID of the button wrapper. 1543 1610 * 1544 1611 * @var string … … 1549 1616 1550 1617 /** 1551 * The destination link of the button 1618 * The destination link of the button. 1552 1619 * 1553 1620 * @var string … … 1556 1623 1557 1624 /** 1558 * The DOM class of the button link 1625 * The DOM class of the button link. 1559 1626 * 1560 1627 * @var string … … 1563 1630 1564 1631 /** 1565 * The DOM ID of the button link 1632 * The DOM ID of the button link. 1566 1633 * 1567 1634 * @var string … … 1570 1637 1571 1638 /** 1572 * The DOM rel value of the button link 1639 * The DOM rel value of the button link. 1573 1640 * 1574 1641 * @var string … … 1577 1644 1578 1645 /** 1579 * Title of the button link 1646 * Title of the button link. 1580 1647 * 1581 1648 * @var string … … 1584 1651 1585 1652 /** 1586 * The contents of the button link 1653 * The contents of the button link. 1587 1654 * 1588 1655 * @var string … … 1597 1664 1598 1665 /** 1599 * Builds the button based on class parameters :1666 * Builds the button based on class parameters. 1600 1667 * 1601 1668 * @since BuddyPress (1.2.6) 1602 1669 * 1603 * @param array $args 1604 * @return bool False if not allowed 1670 * @param array $args See {@BP_Button}. 1671 * @return bool|null Returns false when the button is not allowed for 1672 * the current context. 1605 1673 */ 1606 1674 public function __construct( $args = '' ) { … … 1675 1743 1676 1744 /** 1677 * Return contents of button1745 * Return the markup for the generated button. 1678 1746 * 1679 1747 * @since BuddyPress (1.2.6) 1680 1748 * 1681 * @return string 1749 * @return string Button markup. 1682 1750 */ 1683 1751 public function contents() { … … 1686 1754 1687 1755 /** 1688 * Output contents of button1756 * Output the markup of button. 1689 1757 * 1690 1758 * @since BuddyPress (1.2.6) … … 1697 1765 1698 1766 /** 1699 * BP_Embed1767 * Enable oEmbeds in BuddyPress contexts. 1700 1768 * 1701 1769 * Extends WP_Embed class for use with BuddyPress. 1702 1770 * 1703 * @ package BuddyPress Core1704 * @since BuddyPress (1.5)1771 * @since BuddyPress (1.5.0) 1772 * 1705 1773 * @see WP_Embed 1706 1774 */ … … 1710 1778 * Constructor 1711 1779 * 1712 * @global unknown$wp_embed1780 * @global WP_Embed $wp_embed 1713 1781 */ 1714 1782 public function __construct() { … … 1747 1815 * The {@link do_shortcode()} callback function. 1748 1816 * 1749 * Attempts to convert a URL into embed HTML. Starts by checking the URL against the regex of the registered embed handlers. 1750 * Next, checks the URL against the regex of registered {@link WP_oEmbed} providers if oEmbed discovery is false. 1751 * If none of the regex matches and it's enabled, then the URL will be passed to {@link BP_Embed::parse_oembed()} for oEmbed parsing. 1817 * Attempts to convert a URL into embed HTML. Starts by checking the 1818 * URL against the regex of the registered embed handlers. Next, checks 1819 * the URL against the regex of registered {@link WP_oEmbed} providers 1820 * if oEmbed discovery is false. If none of the regex matches and it's 1821 * enabled, then the URL will be passed to {@link BP_Embed::parse_oembed()} 1822 * for oEmbed parsing. 1752 1823 * 1753 1824 * @uses wp_parse_args() … … 1813 1884 1814 1885 /** 1815 * Base function so BP components / plugins can parse links to be embedded. 1886 * Base function so BP components/plugins can parse links to be embedded. 1887 * 1816 1888 * View an example to add support in {@link bp_activity_embed()}. 1817 1889 * 1818 1890 * @uses apply_filters() Filters cache. 1819 1891 * @uses do_action() To save cache. 1820 * @uses wp_oembed_get() Connects to oEmbed provider and returns HTML on success. 1821 * @uses WP_Embed::maybe_make_link() Process URL for hyperlinking on oEmbed failure. 1892 * @uses wp_oembed_get() Connects to oEmbed provider and returns HTML 1893 * on success. 1894 * @uses WP_Embed::maybe_make_link() Process URL for hyperlinking on 1895 * oEmbed failure. 1896 * 1822 1897 * @param int $id ID to do the caching for. 1823 1898 * @param string $url The URL attempting to be embedded. 1824 1899 * @param array $attr Shortcode attributes from {@link WP_Embed::shortcode()}. 1825 * @param array $rawattr Untouched shortcode attributes from {@link WP_Embed::shortcode()}. 1900 * @param array $rawattr Untouched shortcode attributes from 1901 * {@link WP_Embed::shortcode()}. 1826 1902 * @return string The embed HTML on success, otherwise the original URL. 1827 1903 */ … … 1861 1937 1862 1938 /** 1863 * Create HTML list of BP nav items 1939 * Create HTML list of BP nav items. 1864 1940 * 1865 * @since BuddyPress (1.7 )1941 * @since BuddyPress (1.7.0) 1866 1942 */ 1867 1943 class BP_Walker_Nav_Menu extends Walker_Nav_Menu { 1868 /** 1869 * @since BuddyPress (1.7) 1944 1945 /** 1946 * Description of fields indexes for building markup. 1947 * 1948 * @since BuddyPress (1.7.0) 1870 1949 * @var array 1871 1950 */ … … 1873 1952 1874 1953 /** 1875 * @since BuddyPress (1.7) 1954 * Tree type. 1955 * 1956 * @since BuddyPress (1.7.0) 1876 1957 * @var string 1877 1958 */ … … 1881 1962 * Display array of elements hierarchically. 1882 1963 * 1883 * This method is almost identical to the version in {@link Walker::walk()}. The only change is on one line 1884 * which has been commented. An IF was comparing 0 to a non-empty string which was preventing child elements 1964 * This method is almost identical to the version in {@link Walker::walk()}. 1965 * The only change is on one line which has been commented. An IF was 1966 * comparing 0 to a non-empty string which was preventing child elements 1885 1967 * being grouped under their parent menu element. 1886 1968 * 1887 * This caused a problem for BuddyPress because our primary/secondary navigations doesn't have a unique numerical 1888 * ID that describes a hierarchy (we use a slug). Obviously, WordPress Menus use Posts, and those have ID/post_parent. 1889 * 1890 * @param array $elements 1891 * @param int $max_depth 1892 * @return string 1969 * This caused a problem for BuddyPress because our primary/secondary 1970 * navigations don't have a unique numerical ID that describes a 1971 * hierarchy (we use a slug). Obviously, WordPress Menus use Posts, and 1972 * those have ID/post_parent. 1973 * 1974 * @since BuddyPress (1.7.0) 1975 * 1893 1976 * @see Walker::walk() 1894 * @since BuddyPress (1.7) 1977 * 1978 * @param array $elements See {@link Walker::walk()}. 1979 * @param int $max_depth See {@link Walker::walk()}. 1980 * @return string See {@link Walker::walk()}. 1895 1981 */ 1896 1982 public function walk( $elements, $max_depth ) { … … 1972 2058 1973 2059 /** 1974 * Displays the current <li> that we are on. 1975 * 1976 * @param string $output Passed by reference. Used to append additional content. 2060 * Display the current <li> that we are on. 2061 * 2062 * @see Walker::start_el() for complete description of parameters . 2063 * 2064 * @since BuddyPress (1.7.0) 2065 * 2066 * @param string $output Passed by reference. Used to append 2067 * additional content. 1977 2068 * @param object $item Menu item data object. 1978 * @param int $depth Depth of menu item. Used for padding. Optional, defaults to 0. 1979 * @param array $args Optional 2069 * @param int $depth Depth of menu item. Used for padding. Optional, 2070 * defaults to 0. 2071 * @param array $args Optional. See {@link Walker::start_el()}. 1980 2072 * @param int $current_page Menu item ID. Optional. 1981 * @since BuddyPress (1.7)1982 2073 */ 1983 2074 public function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) { … … 2013 2104 2014 2105 /** 2015 * Create a set of BuddyPress-specific links for use in the Menus admin UI 2106 * Create a set of BuddyPress-specific links for use in the Menus admin UI. 2016 2107 * 2017 * Borrowed heavily from WP's Walker_Nav_Menu_Checklist, but modified so as not2108 * Borrowed heavily from {@link Walker_Nav_Menu_Checklist}, but modified so as not 2018 2109 * to require an actual post type or taxonomy, and to force certain CSS classes 2019 2110 * … … 2021 2112 */ 2022 2113 class BP_Walker_Nav_Menu_Checklist extends Walker_Nav_Menu { 2114 2115 /** 2116 * Constructor. 2117 * 2118 * @see Walker_Nav_Menu::__construct() for a description of parameters. 2119 * 2120 * @param array $fields See {@link Walker_Nav_Menu::__construct()}. 2121 */ 2023 2122 public function __construct( $fields = false ) { 2024 2123 if ( $fields ) { … … 2027 2126 } 2028 2127 2128 /** 2129 * Create the markup to start a tree level. 2130 * 2131 * @see Walker_Nav_Menu::start_lvl() for description of parameters. 2132 * 2133 * @param string $output See {@Walker_Nav_Menu::start_lvl()}. 2134 * @param int $depth See {@Walker_Nav_Menu::start_lvl()}. 2135 * @param array $args See {@Walker_Nav_Menu::start_lvl()}. 2136 */ 2029 2137 public function start_lvl( &$output, $depth = 0, $args = array() ) { 2030 2138 $indent = str_repeat( "\t", $depth ); … … 2032 2140 } 2033 2141 2142 /** 2143 * Create the markup to end a tree level. 2144 * 2145 * @see Walker_Nav_Menu::end_lvl() for description of parameters. 2146 * 2147 * @param string $output See {@Walker_Nav_Menu::end_lvl()}. 2148 * @param int $depth See {@Walker_Nav_Menu::end_lvl()}. 2149 * @param array $args See {@Walker_Nav_Menu::end_lvl()}. 2150 */ 2034 2151 public function end_lvl( &$output, $depth = 0, $args = array() ) { 2035 2152 $indent = str_repeat( "\t", $depth ); … … 2038 2155 2039 2156 /** 2040 * @see Walker::start_el() 2041 * 2042 * @param string $output Passed by reference. Used to append additional content. 2157 * Create the markup to start an element. 2158 * 2159 * @see Walker::start_el() for description of parameters. 2160 * 2161 * @param string $output Passed by reference. Used to append additional 2162 * content. 2043 2163 * @param object $item Menu item data object. 2044 2164 * @param int $depth Depth of menu item. Used for padding. 2045 * @param object $args 2165 * @param object $args See {@Walker::start_el()}. 2166 * @param int $id See {@Walker::start_el()}. 2046 2167 */ 2047 2168 function start_el( &$output, $item, $depth = 0, $args = array(), $id = 0 ) {
Note:
See TracChangeset
for help on using the changeset viewer.
