docs.expressionengine.comWelcome! — ExpressionEngine 7 Documentation

ExpressionEngine Docs {ee:u} Forums v7 v7 v6 v5 v4 v3 v2 v1 Getting Started Welcome Installation & Updates System Requirements Installation Best Practices Updating Site License Management Change Log Quick Start The Big Picture 10 Minute Primer General Information URL Structure 404 Pages Backing Up Your Site Moving to Another Server GDPR Compliance Cookies Text Formatting Converting to InnoDB BBCode Reference Reserved Words Member XML Format Localization Date Localization Language Packs Stopwords Transliteration The Fundamentals Control Panel The Control Panel CP Overview Create Channels Dashboard Management Entry Manager File Manager File Manager Overview Upload Directories Overview Subfolders Synchronizing File Editing Watermarks Field Manager Settings Create/Edit Field Conditional Fields Member Manager Member Profile Template Manager Add-On Manager Categories Utilities Overview Communicate Tool Translation Tool General Utilities Debug Tools Member Tools Database Tools Data Operations System Logs System Settings Overview General Settings Avatar CAPTCHA Comment Content & Design Consents Requests Cookie Settings Debugging & Output Outgoing Email Hit Tracking Logging Member Settings Messaging Security & Privacy Template Access Throttling URL and Path Word Censorship HTML Buttons Menu Manager Front-End Editing Branding CP Navigation Templates Overview Template Language Conditional Tags Embedding Templates Template Layouts Template Partials Template Variables Global Template Variables Single Global Variables Linking to Stylesheets Linking to Scripts URL Segment Variables Consent Variables Path Variables Preload Text Replacements Variable Modifiers Date Variable Formatting Template Routes Pagination The Template Engine Channels Entries Tag Channel Information Tag Next/Previous Entries Spanning Across Pages Entry Views Tracking Entry Cloning Dynamic Parameters Categories Tag Category Archive Tag Category Heading Tag Archive Month Links Channel Sets Calendar Tag Channel Form Channel Form Tag Examples Form Inputs Other Fields Status Selection Category Selection Development Fieldtypes Overview Checkboxes Color Picker Date Duration Email Address File File Grid Fluid Grid Members Notes Number Input Multi Select Relationships Rich Text Editor Radio Buttons Range Slider Select Dropdown Selectable Buttons Text Input Textarea Toggle Value Slider URL Member Management Overview Registration Tag Login Tag Logout Tags Forgot Password Forgot Username Reset Password Multi-Factor Authentication Password Validation Member List Tag Member Search Form Custom Profile Data Tag Edit Profile Data Tag Edit Avatar Tag Member Roles Tags Ignore List Tag Profile Templates (Legacy) Comments Overview Entries Tag Submission Form Subscriptions Control Panel Advanced Usage Config Files Main Configuration File System Config Overrides Additional Config Files ENV File Support Helpful Modules Consent File Search Overview Simple Form Tag Advanced Form Tag Displaying Results Add-Ons Overview Block / Allow Email Emoji HTTP Header Metaweblog API Moblog Pages Pro Search Overview Collections Settings Lexicon Shortcuts Parameters Filters Tags Examples Find and Replace Upgrade from Low Search Development Creating your own Filter Anatomy of a Filter Helper Functions Search index API Extension Hooks Pro Variables Overview Settings Managing Variables Variable Types Template Tags Fieldtype Upgrade from Low Variables Development Fieldtype Bridge Extension Hook Query Request RSS RSS Parser Rich Text Editor Spam Statistics Structure Emoticon (Deprecated) Add-On Development Building An Add-On Start Here Add-on Setup File Add-on Update File Extending the Core Adding Control Panel Pages Adding Actions Adding Fieldtypes Fieldtype Development Fieldtype Example Enhanced Fieldtype Features Adding CLI Commands Creating A Command Defining Input Displaying Output Adding Template Tags Adding Jump Menu Items Using Language Files Adding Publish Form Tabs Adding Prolets Adding Dashboard Widgets Developing Variable Modifiers Modernizing add-ons Accessing the Database Available Core Hooks Overview Global Core Library Email Library Filemanager Library Functions Library Grid Fieldtype RTE Fieldtype Input Library Output Library Pagination Library Relationships Fieldtype Members Fieldtype Session Library Template Library Text Helper Typography Library API Libraries Channel Fields API Template Structure API Control Panel Admin Content Controller CSS Controller Design Controller Javascript Controller Login Controller Members Controller Control Panel Menu My Account Controller Publish Controller Models CategoryField Model CategoryGroup Model Category Model Channel Model Channel Entry Model ChannelFieldGroup Model ChannelField Model ChannelFormSettings Model ChannelLayout Model Comment Model File Model Fluid Field Library GlobalVariable Model MemberField Model Member Model Role Model Site Model Snippet Model SpecialityTemplate Model Status Model TemplateGroup Model TemplateRoute Model Template Model Modules Channel Module Channel Form Comment Module Email Module Forum Module Member Module Member Module Authorization Member Module Registration Member Module Settings Search Module Simple Commerce Module Wiki Module Learn About the Core Services Add-on Service CP/Alert Service Config Service Consent Service Cookie Cookie Registry CSV Library Encrypt Service Event Service CP/FilePicker Service CP/Filter Service Format Service Format Number Formatter Text Formatter IP Address Service LivePreview Service Memory Service CP/Modal Service Model Service Model Fetching Models Relationships Collections Building your own Models Relating Models Cp/Form Service Cp/Form Field Groups Field Sets Fields Buttons CP/Pagination Service Permission Service CP/Sidebar Service Spam Service CP/Table Service CP/URL Service Validation Service View Service Tree Datastructure Models Working with Models Add-on Action Model Add-on Module Model Add-on Extension Model Add-on Fieldtype Model Add-on Plugin Model Category Model Category Field Model Category Group Model Category Group Settings Model Channel Entry Model Channel Field Group Model Channel Field Model Comment Model Comment Subscription Model Cookie Settings Model CP Log Model Developer Log Model Email Console Log Model File Model Fluid Field Model Member Model MemberField Model Role Model RoleGroup Model Status Model RoleSettings Model Template Model Template Group Model Upload Destinations Model Shared Form View Control Panel Javascript Global Variables Custom jQuery Events Table Plugin Ranges and Selections WysiHat API Constants Reference Cypress Tests JSON Version Feed Legacy Reference Common Functions Controllers Drivers Libraries Creating Libraries Benchmarking Class Cache Class Config Class CP Class Database Class Email Class File Uploading Class File Field Library Form Validation Class Functions Class Image Manipulation Class Input Class Javascript Class Language Class Layout Class Loader Class Localize Class Logger Class Mime Type Class Output Class Pagination Class RSS Parser Class Security Class Session Class Table Class Template Class Typography Class URI Class XML Parser Class Database Driver Active Record Query Results Raw Queries and Metadata Database Utility Class Database Forge Class Connecting to an External Database Helpers Array Helper Cookie Helper Directory Helper Download Helper File Helper Form Helper HTML Helper Language Helper Number Helper Path Helper Security Helper String Helper Text Helper URL Helper XML Helper Legacy API Library Channel Categories API Channel Fields API Channel Structure API Template Structure API Guidelines Overview Guidelines Checklist General Style and Syntax In-app Documentation Performance Guidelines Security Guidelines View Files and PHP Syntax Debugging License Validation Overview Importing Licenses Through the API v3 Add-on Migration v4 Add-on Migration v6 Add-on Migration Automated Upgrading Command Line Interface (CLI) Introduction Usage Built In...