Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
05/07/2016 07:38:27 PM (8 years ago)
Author:
tw2113
Message:

Continued XProfile docs cleanup.

See #6406.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-xprofile/bp-xprofile-template.php

    r10712 r10740  
    8484 * Start off the profile groups.
    8585 *
     86 * @since 1.0.0
     87 *
    8688 * @return mixed
    8789 */
     
    9496 * Set up the profile groups.
    9597 *
     98 * @since 1.0.0
     99 *
    96100 * @return mixed
    97101 */
     
    104108 * Whether or not the group has fields to display.
    105109 *
     110 * @since 1.0.0
     111 *
    106112 * @return mixed
    107113 */
     
    116122 * @since 1.0.0
    117123 *
    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.
    122127 */
    123128function bp_field_css_class( $class = false ) {
     
    127132    /**
    128133     * Return the class attribute for a field.
     134     *
     135     * @since 1.1.0
    129136     *
    130137     * @param string|bool $class Extra classes to append to class attribute.
     
    187194 * Whether or not the XProfile field has data to display.
    188195 *
     196 * @since 1.0.0
     197 *
     198 * @global object $profile_template
     199 *
    189200 * @return mixed
    190201 */
     
    197208 * Whether or not the XProfile field has public data to display.
    198209 *
     210 * @since 1.0.0
     211 *
     212 * @global object $profile_template
     213 *
    199214 * @return bool
    200215 */
     
    211226/**
    212227 * Output the XProfile group ID.
     228 *
     229 * @since 1.0.0
    213230 */
    214231function bp_the_profile_group_id() {
     
    219236     * Return the XProfile group ID.
    220237     *
     238     * @since 1.1.0
     239     *
    221240     * @return mixed|void
    222241     */
     
    236255/**
    237256 * Output the XProfile group name.
     257 *
     258 * @since 1.0.0
    238259 */
    239260function bp_the_profile_group_name() {
     
    244265     * Return the XProfile group name.
    245266     *
     267     * @since 1.0.0
     268     *
    246269     * @return mixed|void
    247270     */
     
    261284/**
    262285 * Output the XProfile group slug.
     286 *
     287 * @since 1.1.0
    263288 */
    264289function bp_the_profile_group_slug() {
     
    269294     * Return the XProfile group slug.
    270295     *
     296     * @since 1.1.0
     297     *
    271298     * @return mixed|void
    272299     */
     
    286313/**
    287314 * Output the XProfile group description.
     315 *
     316 * @since 1.0.0
    288317 */
    289318function bp_the_profile_group_description() {
     
    294323     * Return the XProfile group description.
    295324     *
     325     * @since 1.0.0
     326     *
    296327     * @return mixed|void
    297328     */
     
    311342/**
    312343 * Output the XProfile group edit form action.
     344 *
     345 * @since 1.1.0
    313346 */
    314347function bp_the_profile_group_edit_form_action() {
     
    319352     * Return the XProfile group edit form action.
    320353     *
     354     * @since 1.1.0
     355     *
    321356     * @return mixed|void
    322357     */
     
    340375/**
    341376 * Output the XProfile group field IDs.
     377 *
     378 * @since 1.1.0
    342379 */
    343380function bp_the_profile_group_field_ids() {
     
    347384    /**
    348385     * Return the XProfile group field IDs.
     386     *
     387     * @since 1.1.0
    349388     *
    350389     * @return string
     
    404443 * Return the XProfile fields.
    405444 *
     445 * @since 1.0.0
     446 *
    406447 * @return mixed
    407448 */
     
    414455 * Sets up the XProfile field.
    415456 *
     457 * @since 1.0.0
     458 *
    416459 * @return mixed
    417460 */
     
    423466/**
    424467 * Output the XProfile field ID.
     468 *
     469 * @since 1.1.0
    425470 */
    426471function bp_the_profile_field_id() {
     
    430475    /**
    431476     * Return the XProfile field ID.
     477     *
     478     * @since 1.1.0
     479     *
    432480     * @return mixed|void
    433481     */
     
    447495/**
    448496 * Outputs the XProfile field name.
     497 *
     498 * @since 1.0.0
    449499 */
    450500function bp_the_profile_field_name() {
     
    455505     * Returns the XProfile field name.
    456506     *
     507     * @since 1.0.0
     508     *
    457509     * @return mixed|void
    458510     */
     
    472524/**
    473525 * Outputs the XProfile field value.
     526 *
     527 * @since 1.0.0
    474528 */
    475529function bp_the_profile_field_value() {
     
    479533    /**
    480534     * Returns the XProfile field value.
     535     *
     536     * @since 1.0.0
    481537     *
    482538     * @return mixed|void
     
    501557/**
    502558 * Outputs the XProfile field edit value.
     559 *
     560 * @since 1.1.0
    503561 */
    504562function bp_the_profile_field_edit_value() {
     
    508566    /**
    509567     * Returns the XProfile field edit value.
     568     *
     569     * @since 1.1.0
    510570     *
    511571     * @return mixed|void
     
    550610/**
    551611 * Outputs the XProfile field type.
     612 *
     613 * @since 1.1.0
    552614 */
    553615function bp_the_profile_field_type() {
     
    558620     * Returns the XProfile field type.
    559621     *
     622     * @since 1.1.0
     623     *
    560624     * @return mixed|void
    561625     */
     
    575639/**
    576640 * Outputs the XProfile field description.
     641 *
     642 * @since 1.1.0
    577643 */
    578644function bp_the_profile_field_description() {
     
    583649     * Returns the XProfile field description.
    584650     *
     651     * @since 1.1.0
     652     *
    585653     * @return mixed|void
    586654     */
     
    600668/**
    601669 * Outputs the XProfile field input name.
     670 *
     671 * @since 1.1.0
    602672 */
    603673function bp_the_profile_field_input_name() {
     
    607677    /**
    608678     * Retursn the XProfile field input name.
     679     *
     680     * @since 1.1.0
    609681     *
    610682     * @return mixed|void
     
    706778/**
    707779 * Render whether or not a profile field is required.
     780 *
     781 * @since 1.1.0
    708782 */
    709783function bp_the_profile_field_is_required() {
     
    713787    /**
    714788     * Return whether or not a profile field is required.
     789     *
     790     * @since 1.1.0
     791     *
    715792     * @return mixed|void
    716793     */
     
    736813/**
    737814 * Output the visibility level of this field.
     815 *
     816 * @since 1.6.0
    738817 */
    739818function bp_the_profile_field_visibility_level() {
     
    743822    /**
    744823     * Return the visibility level of this field.
     824     *
     825     * @since 1.6.0
    745826     *
    746827     * @return mixed|void
     
    770851/**
    771852 * Echo the visibility level label of this field.
     853 *
     854 * @since 1.6.0
    772855 */
    773856function bp_the_profile_field_visibility_level_label() {
     
    777860    /**
    778861     * Return the visibility level label of this field.
     862     *
     863     * @since 1.6.0
    779864     *
    780865     * @return mixed|void
     
    807892 * Return unserialized profile field data.
    808893 *
     894 * @since 1.0.0
     895 *
    809896 * @param string $value Content to maybe unserialize.
    810897 * @return mixed|string
     
    823910 * Output XProfile field data.
    824911 *
    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}
    826915 */
    827916function bp_profile_field_data( $args = '' ) {
     
    832921     * Return XProfile field data.
    833922     *
    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
    836932     */
    837933    function bp_get_profile_field_data( $args = '' ) {
     
    9711067 * Output the XProfile group name.
    9721068 *
     1069 * @since 1.0.0
     1070 *
    9731071 * @param bool $deprecated Deprecated boolean parameter.
    9741072 * @return mixed|void
     
    9851083     * Return the XProfile group name.
    9861084     *
     1085     * @since 1.0.0
     1086     *
    9871087     * @return mixed|void
    9881088     */
     
    10101110/**
    10111111 * Render a formatted string displaying when a profile was last updated.
     1112 *
     1113 * @since 1.0.0
    10121114 */
    10131115function bp_profile_last_updated() {
     
    10241126    /**
    10251127     * Return a formatted string displaying when a profile was last updated.
     1128     *
     1129     * @since 1.0.0
    10261130     *
    10271131     * @return bool|mixed|void
     
    10481152/**
    10491153 * Display the current profile group ID.
     1154 *
     1155 * @since 1.1.0
    10501156 */
    10511157function bp_current_profile_group_id() {
     
    10801186/**
    10811187 * Render an avatar delete link.
     1188 *
     1189 * @since 1.1.0
    10821190 */
    10831191function bp_avatar_delete_link() {
     
    10891197     *
    10901198     * @since 1.1.0
     1199     *
    10911200     * @return mixed|void
    10921201     */
     
    11051214/**
    11061215 * Render an edit profile button.
     1216 *
     1217 * @since 1.0.0
    11071218 */
    11081219function bp_edit_profile_button() {
     
    11241235 * Echo the field visibility radio buttons.
    11251236 *
    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}
    11271240 */
    11281241function bp_profile_visibility_radio_buttons( $args = '' ) {
     
    11321245     * Return the field visibility radio buttons.
    11331246     *
    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
    11361260     */
    11371261    function bp_profile_get_visibility_radio_buttons( $args = '' ) {
     
    12001324 * @since 2.0.0
    12011325 *
    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}
    12031327 */
    12041328function bp_profile_settings_visibility_select( $args = '' ) {
     
    12101334     * @since 2.0.0
    12111335     *
    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     * }
    12131344     * @return string $retval
    12141345     */
Note: See TracChangeset for help on using the changeset viewer.