Changeset 10740 for trunk/src/bp-xprofile/bp-xprofile-template.php
- Timestamp:
- 05/07/2016 07:38:27 PM (8 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/src/bp-xprofile/bp-xprofile-template.php
r10712 r10740 84 84 * Start off the profile groups. 85 85 * 86 * @since 1.0.0 87 * 86 88 * @return mixed 87 89 */ … … 94 96 * Set up the profile groups. 95 97 * 98 * @since 1.0.0 99 * 96 100 * @return mixed 97 101 */ … … 104 108 * Whether or not the group has fields to display. 105 109 * 110 * @since 1.0.0 111 * 106 112 * @return mixed 107 113 */ … … 116 122 * @since 1.0.0 117 123 * 118 * @param array|string|false $class Extra classes to append to class attribute. 119 * Pass mutiple class names as an array or 120 * space-delimited string. 121 * @return string 124 * @param mixed $class Extra classes to append to class attribute. 125 * Pass mutiple class names as an array or 126 * space-delimited string. 122 127 */ 123 128 function bp_field_css_class( $class = false ) { … … 127 132 /** 128 133 * Return the class attribute for a field. 134 * 135 * @since 1.1.0 129 136 * 130 137 * @param string|bool $class Extra classes to append to class attribute. … … 187 194 * Whether or not the XProfile field has data to display. 188 195 * 196 * @since 1.0.0 197 * 198 * @global object $profile_template 199 * 189 200 * @return mixed 190 201 */ … … 197 208 * Whether or not the XProfile field has public data to display. 198 209 * 210 * @since 1.0.0 211 * 212 * @global object $profile_template 213 * 199 214 * @return bool 200 215 */ … … 211 226 /** 212 227 * Output the XProfile group ID. 228 * 229 * @since 1.0.0 213 230 */ 214 231 function bp_the_profile_group_id() { … … 219 236 * Return the XProfile group ID. 220 237 * 238 * @since 1.1.0 239 * 221 240 * @return mixed|void 222 241 */ … … 236 255 /** 237 256 * Output the XProfile group name. 257 * 258 * @since 1.0.0 238 259 */ 239 260 function bp_the_profile_group_name() { … … 244 265 * Return the XProfile group name. 245 266 * 267 * @since 1.0.0 268 * 246 269 * @return mixed|void 247 270 */ … … 261 284 /** 262 285 * Output the XProfile group slug. 286 * 287 * @since 1.1.0 263 288 */ 264 289 function bp_the_profile_group_slug() { … … 269 294 * Return the XProfile group slug. 270 295 * 296 * @since 1.1.0 297 * 271 298 * @return mixed|void 272 299 */ … … 286 313 /** 287 314 * Output the XProfile group description. 315 * 316 * @since 1.0.0 288 317 */ 289 318 function bp_the_profile_group_description() { … … 294 323 * Return the XProfile group description. 295 324 * 325 * @since 1.0.0 326 * 296 327 * @return mixed|void 297 328 */ … … 311 342 /** 312 343 * Output the XProfile group edit form action. 344 * 345 * @since 1.1.0 313 346 */ 314 347 function bp_the_profile_group_edit_form_action() { … … 319 352 * Return the XProfile group edit form action. 320 353 * 354 * @since 1.1.0 355 * 321 356 * @return mixed|void 322 357 */ … … 340 375 /** 341 376 * Output the XProfile group field IDs. 377 * 378 * @since 1.1.0 342 379 */ 343 380 function bp_the_profile_group_field_ids() { … … 347 384 /** 348 385 * Return the XProfile group field IDs. 386 * 387 * @since 1.1.0 349 388 * 350 389 * @return string … … 404 443 * Return the XProfile fields. 405 444 * 445 * @since 1.0.0 446 * 406 447 * @return mixed 407 448 */ … … 414 455 * Sets up the XProfile field. 415 456 * 457 * @since 1.0.0 458 * 416 459 * @return mixed 417 460 */ … … 423 466 /** 424 467 * Output the XProfile field ID. 468 * 469 * @since 1.1.0 425 470 */ 426 471 function bp_the_profile_field_id() { … … 430 475 /** 431 476 * Return the XProfile field ID. 477 * 478 * @since 1.1.0 479 * 432 480 * @return mixed|void 433 481 */ … … 447 495 /** 448 496 * Outputs the XProfile field name. 497 * 498 * @since 1.0.0 449 499 */ 450 500 function bp_the_profile_field_name() { … … 455 505 * Returns the XProfile field name. 456 506 * 507 * @since 1.0.0 508 * 457 509 * @return mixed|void 458 510 */ … … 472 524 /** 473 525 * Outputs the XProfile field value. 526 * 527 * @since 1.0.0 474 528 */ 475 529 function bp_the_profile_field_value() { … … 479 533 /** 480 534 * Returns the XProfile field value. 535 * 536 * @since 1.0.0 481 537 * 482 538 * @return mixed|void … … 501 557 /** 502 558 * Outputs the XProfile field edit value. 559 * 560 * @since 1.1.0 503 561 */ 504 562 function bp_the_profile_field_edit_value() { … … 508 566 /** 509 567 * Returns the XProfile field edit value. 568 * 569 * @since 1.1.0 510 570 * 511 571 * @return mixed|void … … 550 610 /** 551 611 * Outputs the XProfile field type. 612 * 613 * @since 1.1.0 552 614 */ 553 615 function bp_the_profile_field_type() { … … 558 620 * Returns the XProfile field type. 559 621 * 622 * @since 1.1.0 623 * 560 624 * @return mixed|void 561 625 */ … … 575 639 /** 576 640 * Outputs the XProfile field description. 641 * 642 * @since 1.1.0 577 643 */ 578 644 function bp_the_profile_field_description() { … … 583 649 * Returns the XProfile field description. 584 650 * 651 * @since 1.1.0 652 * 585 653 * @return mixed|void 586 654 */ … … 600 668 /** 601 669 * Outputs the XProfile field input name. 670 * 671 * @since 1.1.0 602 672 */ 603 673 function bp_the_profile_field_input_name() { … … 607 677 /** 608 678 * Retursn the XProfile field input name. 679 * 680 * @since 1.1.0 609 681 * 610 682 * @return mixed|void … … 706 778 /** 707 779 * Render whether or not a profile field is required. 780 * 781 * @since 1.1.0 708 782 */ 709 783 function bp_the_profile_field_is_required() { … … 713 787 /** 714 788 * Return whether or not a profile field is required. 789 * 790 * @since 1.1.0 791 * 715 792 * @return mixed|void 716 793 */ … … 736 813 /** 737 814 * Output the visibility level of this field. 815 * 816 * @since 1.6.0 738 817 */ 739 818 function bp_the_profile_field_visibility_level() { … … 743 822 /** 744 823 * Return the visibility level of this field. 824 * 825 * @since 1.6.0 745 826 * 746 827 * @return mixed|void … … 770 851 /** 771 852 * Echo the visibility level label of this field. 853 * 854 * @since 1.6.0 772 855 */ 773 856 function bp_the_profile_field_visibility_level_label() { … … 777 860 /** 778 861 * Return the visibility level label of this field. 862 * 863 * @since 1.6.0 779 864 * 780 865 * @return mixed|void … … 807 892 * Return unserialized profile field data. 808 893 * 894 * @since 1.0.0 895 * 809 896 * @param string $value Content to maybe unserialize. 810 897 * @return mixed|string … … 823 910 * Output XProfile field data. 824 911 * 825 * @param string|array $args Array of arguments for field data. 912 * @since 1.2.0 913 * 914 * @param string|array $args Array of arguments for field data. See {@link bp_get_profile_field_data} 826 915 */ 827 916 function bp_profile_field_data( $args = '' ) { … … 832 921 * Return XProfile field data. 833 922 * 834 * @param string|array $args Array of arguments for field data. 835 * @return mixed|void 923 * @since 1.2.0 924 * 925 * @param string|array $args { 926 * Array of arguments for field data. 927 * 928 * @type string|int|bool $field Field identifier. 929 * @type int $user_id ID of the user to get field data for. 930 * } 931 * @return mixed|void 836 932 */ 837 933 function bp_get_profile_field_data( $args = '' ) { … … 971 1067 * Output the XProfile group name. 972 1068 * 1069 * @since 1.0.0 1070 * 973 1071 * @param bool $deprecated Deprecated boolean parameter. 974 1072 * @return mixed|void … … 985 1083 * Return the XProfile group name. 986 1084 * 1085 * @since 1.0.0 1086 * 987 1087 * @return mixed|void 988 1088 */ … … 1010 1110 /** 1011 1111 * Render a formatted string displaying when a profile was last updated. 1112 * 1113 * @since 1.0.0 1012 1114 */ 1013 1115 function bp_profile_last_updated() { … … 1024 1126 /** 1025 1127 * Return a formatted string displaying when a profile was last updated. 1128 * 1129 * @since 1.0.0 1026 1130 * 1027 1131 * @return bool|mixed|void … … 1048 1152 /** 1049 1153 * Display the current profile group ID. 1154 * 1155 * @since 1.1.0 1050 1156 */ 1051 1157 function bp_current_profile_group_id() { … … 1080 1186 /** 1081 1187 * Render an avatar delete link. 1188 * 1189 * @since 1.1.0 1082 1190 */ 1083 1191 function bp_avatar_delete_link() { … … 1089 1197 * 1090 1198 * @since 1.1.0 1199 * 1091 1200 * @return mixed|void 1092 1201 */ … … 1105 1214 /** 1106 1215 * Render an edit profile button. 1216 * 1217 * @since 1.0.0 1107 1218 */ 1108 1219 function bp_edit_profile_button() { … … 1124 1235 * Echo the field visibility radio buttons. 1125 1236 * 1126 * @param array|string $args Args for the radio buttons. 1237 * @since 1.6.0 1238 * 1239 * @param array|string $args Args for the radio buttons. See {@link bp_profile_get_visibility_radio_buttons} 1127 1240 */ 1128 1241 function bp_profile_visibility_radio_buttons( $args = '' ) { … … 1132 1245 * Return the field visibility radio buttons. 1133 1246 * 1134 * @param array|string $args Args for the radio buttons. 1135 * @return string $retval 1247 * @since 1.6.0 1248 * 1249 * @param array|string $args { 1250 * Args for the radio buttons. 1251 * 1252 * @type int $field_id ID of the field to render. 1253 * @type string $before Markup to render before the field. 1254 * @type string $after Markup to render after the field. 1255 * @type string $before_radio Markup to render before the radio button. 1256 * @type string $after_radio Markup to render after the radio button. 1257 * @type string $class Class to apply to the field markup. 1258 * } 1259 * @return string $retval 1136 1260 */ 1137 1261 function bp_profile_get_visibility_radio_buttons( $args = '' ) { … … 1200 1324 * @since 2.0.0 1201 1325 * 1202 * @param array|string $args Args for the select list. 1326 * @param array|string $args Args for the select list. See {@link bp_profile_get_settings_visibility_select} 1203 1327 */ 1204 1328 function bp_profile_settings_visibility_select( $args = '' ) { … … 1210 1334 * @since 2.0.0 1211 1335 * 1212 * @param array|string $args Args for the select list. 1336 * @param array|string $args { 1337 * Args for the select list. 1338 * 1339 * @type int $field_id ID of the field to render. 1340 * @type string $before Markup to render before the field. 1341 * @type string $after Markup to render after the field. 1342 * @type string $class Class to apply to the field markup. 1343 * } 1213 1344 * @return string $retval 1214 1345 */
Note: See TracChangeset
for help on using the changeset viewer.