TXP Defined Functions
From Textbook
en/Main Page | Function Editing Instructions | TXP Defined Functions (By File) | TXP Defined Functions (Alphabetically)
Contents |
TXP Defined Functions
About
Plugin developers have TXP functions available to them to help facilitate in the process of coding a plugin. For access to definitions and references to the functions in the TXP source code, go here. Below is a list of all the functions available to developers, purpose of each functions, and examples on proper use.
Functions
The following list of functions is an unorganized list, however a list categorized list by file does exist.
Uncategorized
- add_declaration()
- add_estimate()
- add_privs()
- addcall()
- addcallback()
- addevent()
- addsel()
- admin()
- advanced_prefs()
- advanced_prefs_save()
- apache_module()
- areas()
- areatab()
- array_slash()
- article_delete()
- article_edit()
- article_post()
- article_save()
- asshead()
- assrow()
- astag()
- atom()
- author_change_pass()
- author_delete()
- author_list()
- author_pop()
- author_save()
- author_save_new()
- block()
- blocklite()
- bombshelter()
- build_file_path()
- buildcustomsql()
- calculatetype()
- call()
- callback_event()
- cat_article_create()
- cat_article_edit()
- cat_article_list()
- cat_article_multiedit_form()
- cat_article_save()
- cat_category_list()
- cat_category_multiedit()
- cat_event_category_create()
- cat_event_category_edit()
- cat_event_category_list()
- cat_event_category_save()
- cat_file_create()
- cat_file_edit()
- cat_file_list()
- cat_file_save()
- cat_image_create()
- cat_image_edit()
- cat_image_list()
- cat_image_save()
- cat_link_create()
- cat_link_edit()
- cat_link_list()
- cat_link_save()
- cat_parent_pop()
- category_pop()
- category_popup()
- cdata()
- change_email()
- change_email_form()
- change_pass()
- check_import_file()
- check_privs()
- check_url_title()
- checkban()
- checkcommentsallowed()
- checkifneighbour()
- checknonce()
- checkrefs()
- checkupdates()
- chooselang()
- chopurl()
- chunk()
- ckex()
- ckexid()
- clean_comment_counts()
- clean_url()
- cleanfinput()
- cleanselects()
- cleanwhitespace()
- cmap()
- code()
- column_head()
- comment()
- comment_anchor()
- comment_email()
- comment_evaluation()
- comment_id()
- comment_message()
- comment_name()
- comment_permlink()
- comment_time()
- comment_web()
- commentform()
- commentmode()
- comments()
- comments_annotateinvite()
- comments_count()
- comments_error()
- comments_form()
- comments_help()
- comments_invite()
- comments_preview()
- createtxp()
- cs()
- css_copy()
- css_delete()
- css_edit()
- css_edit_form()
- css_edit_raw()
- css_format()
- css_list()
- css_pop()
- css_save()
- css_save_posted()
- custfield()
- dateformats()
- db()
- db_down()
- decode_high()
- deentbrackets()
- delete_declaration()
- deselectall()
- destroycookies()
- discuss()
- discuss_change_pageby()
- discuss_edit()
- discuss_list()
- discuss_multi_edit()
- discuss_multiedit_form()
- discuss_save()
- div_edit()
- div_save()
- dlink()
- dmp()
- do_pings()
- doarray()
- doarticle()
- doarticlehref()
- doarticles()
- doauth()
- dobr()
- dodeent()
- dodiagnostics()
- doimportb2()
- doimportblogger()
- doimportmt()
- doimportmtdb()
- doimportwp()
- dolabel()
- dologinform()
- dopbr()
- dopermlink()
- doslash()
- dospecial()
- dostrip()
- dostriptags()
- dotag()
- dotxpvalidate()
- dowrap()
- dumbdown()
- dump()
- ee()
- elink()
- encode_high()
- encodeentities()
- end_page()
- enumpostitems()
- error()
- escape_title()
- evalelse()
- evalstring()
- event_category_popup()
- event_change_pageby()
- event_multi_edit()
- event_multiedit_form()
- extract_div()
- fbcreate()
- fblock()
- fcode()
- feed_link()
- fetch()
- fetch_category_title()
- fetch_editable()
- fetch_form()
- fetch_section_title()
- fetchcomments()
- file_category_pop()
- file_change_max_size()
- file_change_pageby()
- file_create()
- file_db_add()
- file_delete()
- file_edit()
- file_get_uploaded()
- file_get_uploaded_name()
- file_insert()
- file_list()
- file_replace()
- file_reset_count()
- file_save()
- file_set_perm()
- file_upload_form()
- filedownloadfetchinfo()
- filedownloadformattime()
- filterfrontpage()
- filtersearch()
- find_temp_dir()
- fixentities()
- fixup_for_feed()
- footnoteid()
- footnoteref()
- form()
- form_create()
- form_delete()
- form_edit()
- form_list()
- form_multi_edit()
- form_pop()
- form_save()
- formatcommentsinvite()
- formatpermlink()
- formtypes()
- ftextile()
- gatt()
- generate_password()
- get_author_name()
- get_comment_evaluator()
- get_filenames()
- get_lang_files()
- get_language()
- get_prefs()
- get_priv_level()
- get_result()
- get_result_message()
- get_status_message()
- get_uploaded_file()
- getatt()
- getcapabilities()
- getcomment()
- getcount()
- getcustomfields()
- getdbinfo()
- getdefaultsection()
- geterrorcode()
- geterrormessage()
- getiso()
- getlength()
- getlocale()
- getmicrotime()
- getneighbour()
- getnextnonce()
- getnextprev()
- getnextsecret()
- getrefs()
- getresponse()
- getrow()
- getrows()
- getstatusnum()
- getthing()
- getthings()
- gettimestamp()
- gettree()
- gettreepath()
- gettxplogin()
- getxml()
- glyphs()
- gmtoffset_select()
- gps()
- gpsa()
- gtxt()
- has_privs()
- hasmethod()
- hasrawtext()
- href()
- htmlpre()
- ialign()
- image()
- image_change_pageby()
- image_data()
- image_delete()
- image_display()
- image_edit()
- image_index()
- image_insert()
- image_list()
- image_replace()
- image_save()
- img()
- import_blogger_item()
- import_mt_item()
- import_section_popup()
- in_list()
- include_plugin()
- incomingentities()
- input()
- input_textarea()
- inputlimit()
- inputmonth()
- insert_logit()
- install_lang_key()
- install_language_from_file()
- ipban_add()
- ipban_list()
- ipban_unban()
- is_blacklisted()
- is_windows()
- iserror()
- ispost()
- isstruct()
- ixr_base64()
- ixr_client()
- ixr_clientmulticall()
- ixr_date()
- ixr_error()
- ixr_introspectionserver()
- ixr_message()
- ixr_request()
- ixr_server()
- ixr_value()
- join_qs()
- key_input()
- keywords()
- langs()
- languages()
- lastmod()
- legacy_form()
- link_category_pop()
- link_change_pageby()
- link_delete()
- link_edit()
- link_feed_link()
- link_list()
- link_multi_edit()
- link_multiedit_form()
- link_post()
- link_save()
- linkcategory_popup()
- links()
- list_change_pageby()
- list_languages()
- list_list()
- list_multi_edit()
- list_multiedit_form()
- list_nav_form()
- list_searching_form()
- listmethods()
- lists()
- load_lang()
- load_lang_dates()
- load_lang_event()
- load_plugin()
- load_plugins()
- log_list()
- logging()
- logit()
- lookupbydatetitle()
- lookupbyid()
- lookupbytitle()
- lookupbytitlesection()
- lt()
- mail_comment()
- make_download_link()
- makeconfig()
- makeout()
- markup_comment()
- maxmemusage()
- message()
- messenger()
- methodhelp()
- methodsignature()
- multicall()
- myerrorhandler()
- navpop()
- new_author_form()
- new_pass_form()
- newest_file()
- nextrow()
- notextile()
- numrows()
- output()
- output_css()
- page_delete()
- page_edit()
- page_edit_form()
- page_list()
- page_save()
- page_url()
- pageby_form()
- pagelinkurl()
- pagetop()
- parse()
- parsearticles()
- parsecss()
- parseiso()
- parsepostedcss()
- parsetimestamp()
- pba()
- pcs()
- permlinkmodes()
- permlinkurl()
- permlinkurl_id()
- plugin_delete()
- plugin_edit()
- plugin_edit_form()
- plugin_form()
- plugin_help()
- plugin_install()
- plugin_list()
- plugin_save()
- plugin_verify()
- pluginerrorhandler()
- popcomments()
- pophelp()
- pophelpsubtle()
- poptag()
- poptaglinks()
- populatearticledata()
- popup()
- postdecode()
- posted()
- postencode()
- poweredit()
- pref_func()
- pref_text()
- prefs_list()
- prefs_save()
- pretext()
- prev_title()
- prevnext_link()
- prevnextlink()
- printconfig()
- privs()
- processtags()
- prod_levels()
- ps()
- psa()
- psas()
- query()
- real_max_upload_size()
- rebuild_tree()
- refs()
- register_callback()
- register_page_extension()
- register_tab()
- related_articles()
- relurl()
- require_plugin()
- require_privs()
- reset_author_pass_form()
- retrieve()
- rss()
- rss_safe_hed()
- safe_hed()
- safe_show()
- safe_strftime()
- savecomment()
- sdoslash()
- sec_section_list()
- section()
- section_create()
- section_delete()
- section_list()
- section_pop()
- section_popup()
- section_save()
- select_buttons()
- selectall()
- selectinput()
- selectrange()
- send_new_password()
- send_password()
- serve()
- serverset()
- set_error_level()
- set_pref()
- setcallbacks()
- setcapabilities()
- setcookies()
- setup_load_lang()
- shelve()
- shift_uploaded_file()
- short_preview()
- showhidefields()
- sidehelp()
- since()
- sizeimage()
- slink()
- sort_pop()
- sortdir_pop()
- splat()
- start_import()
- startrows()
- startskeltable()
- status_link()
- status_radio()
- strip_rn()
- stripphp()
- strippost()
- stripspace()
- switch_status()
- switch_tool()
- tab()
- tabber()
- table()
- tabsort()
- tag()
- tagerrorhandler()
- taglinks()
- tagrow()
- test_tempdir()
- text()
- text_area()
- text_input()
- textarea()
- textile_main_fields()
- textile_popup_help()
- textpattern()
- thumbnail_create()
- thumbnail_insert()
- toggledisplay()
- trace_add()
- treeselectinput()
- tsi()
- txp_die()
- txp_status_header()
- txp_validate()
- txpmail()
- txtgps()
- type_options()
- type_select()
- tz_offset()
- undoslash()
- update_comments_count()
- updatesitepath()
- upload_form()
- upload_get_errormsg()
- urlmodes()
- valign()
- verify()
- weeks()
- wlink()
- write()
- write_trace()
- yes_no()
- yesno_pop()
Backend user interface elements
Functions encapsulating HTML tags, form elements and various other building blocks which are useful for the design of a backend user interface layout. Take a look at /textpattern/include/txp_article.php and other files in that directory to learn from existing code.
- alink()
- button()
- checkbox()
- checkbox2()
- endtable()
- einput()
- thumb_ui()
- yesnoradio()
- finput()
- fimage()
- finputcell()
- flabelcell()
- flink()
- flist()
- fspan()
- ftable()
- graf()
- halign()
- hcell()
- hed()
- hinput()
- onoffradio()
- radio()
- sinput()
- small()
- span()
- stackrows()
- starttable()
- strong()
- tb()
- tbd()
- td()
- tda()
- tdb()
- tdcs()
- tdrs()
- tdtl()
- tr()
Database Layer
Functions for inserts, updates, queries and other database oriented tasks. Provides exception handling and optional debugging output.
- safe_alter()
- safe_column()
- safe_count()
- safe_delete()
- safe_field()
- safe_insert()
- safe_optimize()
- safe_query()
- safe_repair()
- safe_row()
- safe_rows()
- safe_rows_start()
- safe_update()
- safe_upsert()
Tag Handlers
Functions which execute a <txp:foo> tag by receiving attributes and returning HTML output. Read /textpattern/publish/taghandlers.php to learn and borrow from existing code.
- article_custom()
- article()
- article_image()
- article_id()
- author()
- body()
- breadcrumb()
- category()
- category1()
- category2()
- category_list()
- css()
- custom_field()
- email()
- error_message()
- error_status()
- excerpt()
- file_download()
- file_download_category()
- file_download_created()
- file_download_description()
- file_download_downloads()
- file_download_id()
- file_download_link()
- file_download_list()
- file_download_modified()
- file_download_name()
- file_download_size()
- if_article_category()
- if_article_list()
- if_article_section()
- if_category()
- if_comments()
- if_comments_allowed()
- if_comments_disallowed()
- if_comments_error()
- if_comments_preview()
- if_custom_field()
- if_different()
- if_excerpt()
- if_first_article()
- if_individual_article()
- if_last_article()
- if_search()
- if_section()
- if_status()
- lang()
- link_to_home()
- link_to_next()
- link_to_prev()
- linklist()
- meta_author()
- meta_keywords()
- newer()
- next_title()
- older()
- output_form()
- page_title()
- password_protect()
- permlink()
- php()
- recent_articles()
- recent_comments()
- search()
- search_input()
- search_result_count()
- search_result_date()
- search_result_excerpt()
- search_result_title()
- search_result_url()
- site_slogan()
- site_url()
- thumbnail()
- title()
Tag Handler Helpers
Tag Builder
Generate markup for a given <txp:foo> tag from the backend interface.
- tag_article()
- tag_article_custom()
- tag_article_image()
- tag_author()
- tag_body()
- tag_breadcrumb()
- tag_category1()
- tag_category2()
- tag_category_list()
- tag_close()
- tag_comment_email_input()
- tag_comment_message_input()
- tag_comment_name()
- tag_comment_name_input()
- tag_comment_permlink()
- tag_comment_preview()
- tag_comment_remember()
- tag_comment_submit()
- tag_comment_time()
- tag_comment_web_input()
- tag_comments_invite()
- tag_css()
- tag_email()
- tag_excerpt()
- tag_feed_link()
- tag_file()
- tag_file_download()
- tag_file_download_category()
- tag_file_download_created()
- tag_file_download_description()
- tag_file_download_downloads()
- tag_file_download_id()
- tag_file_download_link()
- tag_file_download_list()
- tag_file_download_modified()
- tag_file_download_name()
- tag_file_download_size()
- tag_image()
- tag_lang()
- tag_link()
- tag_link_description()
- tag_link_feed_link()
- tag_link_text()
- tag_link_to_home()
- tag_link_to_next()
- tag_link_to_prev()
- tag_linkdesctitle()
- tag_linklist()
- tag_message()
- tag_newer()
- tag_next_title()
- tag_older()
- tag_open()
- tag_output_form()
- tag_page_title()
- tag_paging_link()
- tag_password_protect()
- tag_permlink()
- tag_popup()
- tag_posted()
- tag_prev_title()
- tag_recent_articles()
- tag_recent_comments()
- tag_related_articles()
- tag_search_input()
- tag_search_result_date()
- tag_search_result_excerpt()
- tag_search_result_title()
- tag_search_result_url()
- tag_section()
- tag_site_slogan()
- tag_sitename()
- tag_title()
