Moodle APIs 4.1
Moodle 4.1.9+ (Build: 20240402)
Files | Namespaces | Classes | Functions | Variables
profilefield_social

Files

file  define.class.php
 Textarea profile field define.
 
file  field.class.php
 Social profile field define.
 
file  helper.php
 Contains class profilefield_social::networks.
 
file  provider.php
 Privacy class for requesting user data.
 
file  upgradelib.php
 Contains upgrade and install functions for the social profile fields.
 
file  version.php
 Version information for the social profile field.
 

Namespaces

 
 

Classes

class  profile_define_social
 Class profile_define_social. More...
 
class  profile_field_social
 Class profile_field_social. More...
 
class  profilefield_social\helper
 helper class for social profile fields. More...
 
class  profilefield_social\privacy\provider
 Privacy class for requesting user data. More...
 

Functions

 user_profile_social_create_info_category ()
 Create the default category for custom profile fields if it does not exist yet.
 
 user_profile_social_create_profilefield ($social)
 Create an new custom social profile field if it does not exist.
 
 user_profile_social_moveto_profilefield ($social)
 Called on upgrade to create new profile fields based on the old user table columns for icq, msn, aim, skype and url.
 
 user_profile_social_update_availability_structure (&$structure)
 Loop through the availability info and change all move standard profile fields for icq, skype, aim, yahoo, msn and url to be custom profile fields.
 
 user_profile_social_update_module_availability ()
 Update the module availability configuration for all course modules.
 

Variables

 $plugin = 2022111800
 
$plugin component = 'profilefield_social'
 
$plugin version = 2022112800
 

Detailed Description

Function Documentation

◆ user_profile_social_create_info_category()

user_profile_social_create_info_category ( )

Create the default category for custom profile fields if it does not exist yet.

Return values
intCategory ID for social user profile category.

◆ user_profile_social_create_profilefield()

user_profile_social_create_profilefield (   $social)

Create an new custom social profile field if it does not exist.

Parameters
string$socialSocial profile field.
Return values
objectDB record or social profield field.

◆ user_profile_social_moveto_profilefield()

user_profile_social_moveto_profilefield (   $social)

Called on upgrade to create new profile fields based on the old user table columns for icq, msn, aim, skype and url.

Parameters
string$socialSocial profile field.

◆ user_profile_social_update_availability_structure()

user_profile_social_update_availability_structure ( $structure)

Loop through the availability info and change all move standard profile fields for icq, skype, aim, yahoo, msn and url to be custom profile fields.

Parameters
mixed$structureThe availability object.