You are here

function editor_profile_create in Editor 5

Same name and namespace in other branches
  1. 6 editor.module \editor_profile_create()

Create a profile object.

@returns object

Parameters

string $prid : A unique identifier. This may be something similar to 'basic', or 'full'.

string $profile_string : A string of pid's and placeholders used which is parsed later parsed into an array. The following place holders are available.

  • '|': spacer

string $name : A human readable string which should be wrapped in t().

string $description : (optional) Description wrapped in t().

1 call to editor_profile_create()
editor_editor_profiles in ./editor.profiles.inc
Default editor profiles.

File

./editor.module, line 359
Extendable WYSIWYG editor @author Tj Holowaychuk <tj@vision-media.ca> @link http://vision-media.ca @package Editor

Code

function editor_profile_create($prid, $name, $profile_string, $description = '') {
  $profile = new stdClass();
  $profile->prid = $prid;
  $profile->name = $name;
  $profile->profile_string = $profile_string;
  $profile->description = $description;
  return $profile;
}