TextBook

From Textbook

Contents 1 TXP Defined Functions 1.1 About 1.2 Function Editing Instructions 1.3 Functions 1.3.1 textpattern/publish.php 1.3.2 textpattern/include/ Directory 1.3.2.1 textpattern/include/import/ Directory 1.3.2.1.1 textpattern/include/import/import_b2.php 1.3.2.1.2 textpattern/include/import/import_blogger.php 1.3.2.1.3 textpattern/include/import/import_mt.php 1.3.2.1.4 textpattern/include/import/import_mtdb.php 1.3.2.1.5 textpattern/include/import/import_wp.php 1.3.2.2 textpattern/include/txp_admin.php 1.3.2.3 textpattern/include/txp_article.php 1.3.2.4 textpattern/include/txp_auth.php 1.3.2.5 textpattern/include/txp_category.php 1.3.2.6 textpattern/include/txp_css.php 1.3.2.7 textpattern/include/txp_diag.php 1.3.2.8 textpattern/include/txp_discuss.php 1.3.2.9 textpattern/include/txp_file.php 1.3.2.10 textpattern/include/txp_form.php 1.3.2.11 textpattern/include/txp_image.php 1.3.2.12 textpattern/include/txp_import.php 1.3.2.13 textpattern/include/txp_link.php 1.3.2.14 textpattern/include/txp_list.php 1.3.2.15 textpattern/include/txp_log.php 1.3.2.16 textpattern/include/txp_page.php 1.3.2.17 textpattern/include/txp_plugin.php 1.3.2.18 textpattern/include/txp_prefs.php 1.3.2.19 textpattern/include/txp_preview.php 1.3.2.20 textpattern/include/txp_section.php 1.3.2.21 textpattern/include/txp_tag.php 1.3.3 textpattern/lib/ Directory 1.3.3.1 textpattern/lib/IXRClass.php 1.3.3.2 textpattern/lib/admin_config.php 1.3.3.3 textpattern/lib/class.thumb.php 1.3.3.4 textpattern/lib/classTextile.php 1.3.3.5 textpattern/lib/txplib_db.php 1.3.3.6 textpattern/lib/txplib_forms.php 1.3.3.7 textpattern/lib/txplib_head.php 1.3.3.8 textpattern/lib/txplib_html.php 1.3.3.9 textpattern/lib/txplib_misc.php 1.3.3.10 textpattern/lib/txplib_update.php 1.3.3.11 textpattern/lib/txplib_wrapper.php 1.3.4 textpattern/publish/ Directory 1.3.4.1 textpattern/publish/atom.php 1.3.4.2 textpattern/publish/comment.php 1.3.4.3 textpattern/publish/log.php 1.3.4.4 textpattern/publish/rss.php 1.3.4.5 textpattern/publish/search.php 1.3.4.6 textpattern/publish/taghandlers.php 1.3.5 textpattern/setup/ Directory 1.3.5.1 textpattern/setup/en-gb.php 1.3.5.2 textpattern/setup/index.php 1.3.5.3 textpattern/setup/setuplangs.php 1.3.5.4 textpattern/setup/txpsql.php 1.3.6 textpattern/update/ Directory 1.3.6.1 textpattern/update/_to_1.0.0.php 1.3.6.2 textpattern/update/_to_4.0.2.php 1.3.6.3 textpattern/update/_to_4.0.3.php 1.3.6.4 textpattern/update/_to_4.0.4.php 1.3.6.5 textpattern/update/_update.php

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.

Function Editing Instructions

If you would like to help in cataloguing all of the TXP functions in the wiki, please follow the TXP Defined Function Editing Reference.

Functions

These functions are categorized by File. The file hierarchy is as follows. There also exists a list currently categorized alphabetically.

textpattern/publish.php

• preText()
• textpattern()
• output_css()
• article()
• doArticles()
• filterFrontPage()
• doArticle()
• article_custom()
• parseArticles()
• populateArticleData()
• getNeighbour()
• getNextPrev()
• lastMod()
• parse()
• processTags()
• bombShelter()
• evalString()
• getCustomFields()
• buildCustomSql()
• getStatusNum()
• ckEx()
• ckExID()
• lookupByTitle()
• lookupByTitleSection()
• lookupByIDSection()
• lookupByID()
• lookupByDateTitle()
• makeOut()
• chopUrl()

textpattern/include/ Directory

textpattern/include/import/ Directory

textpattern/include/import/import_b2.php

• doImportB2()

textpattern/include/import/import_blogger.php

• doImportBLOGGER()
• import_blogger_item()

textpattern/include/import/import_mt.php

• doImportMT()
• import_mt_item()

textpattern/include/import/import_mtdb.php

• doImportMTDB()

textpattern/include/import/import_wp.php

• doImportWP()
• undoSlash()

textpattern/include/txp_admin.php

• admin()
• change_email()
• author_save()
• change_pass()
• author_save_new()
• privs()
• get_priv_level()
• send_password()
• send_new_password()
• generate_password()
• new_pass_form()
• reset_author_pass_form()
• author_change_pass()
• change_email_form()
• author_list()
• author_delete()
• new_author_form()

textpattern/include/txp_article.php

• article_post()
• article_save()
• article_edit()
• custField()
• checkIfNeighbour()
• tsi()
• side_help()
• status_radio()
• category_popup()
• section_popup()
• tab()
• getDefaultSection()
• form_pop()
• check_url_title()
• get_status_message()
• textile_main_fields()
• do_pings()

textpattern/include/txp_auth.php

• doAuth()
• txp_validate()
• doLoginForm()
• doTxpValidate()

textpattern/include/txp_category.php

• cat_category_list()
• cat_article_list()
• cat_article_create()
• cat_article_edit()
• cat_article_save()
• cat_parent_pop()
• cat_link_list()
• cat_link_create()
• cat_link_edit()
• cat_link_save()
• cat_image_list()
• cat_image_create()
• cat_image_edit()
• cat_image_save()
• cat_article_multiedit_form()
• cat_category_multiedit()
• cat_event_category_list()
• cat_event_category_create()
• cat_event_category_edit()
• cat_event_category_save()
• cat_file_list()
• cat_file_create()
• cat_file_edit()
• cat_file_save()

textpattern/include/txp_css.php

• css_list()
• css_edit()
• css_edit_form()
• css_edit_raw()
• parseCSS()
• parsePostedCSS()
• css_copy()
• css_save_posted()
• css_save()
• css_format()
• addSel()
• add_declaration()
• delete_declaration()
• css_delete()

textpattern/include/txp_diag.php

• apache_module()
• test_tempdir()
• list_txp_tables()
• check_tables()
• doDiagnostics()

textpattern/include/txp_discuss.php

• discuss_save()
• short_preview()
• discuss_list()
• discuss_search_form()
• discuss_edit()
• ipban_add()
• ipban_unban()
• ipban_list()
• discuss_change_pageby()
• discuss_multiedit_form()
• discuss_multi_edit()

textpattern/include/txp_file.php

• file_list()
• file_search_form()
• file_edit()
• file_db_add()
• file_create()
• file_insert()
• file_replace()
• file_reset_count()
• file_save()
• file_delete()
• file_get_uploaded_name()
• file_get_uploaded()
• file_set_perm()
• file_upload_form()
• file_change_pageby()
• file_change_max_size()
• make_download_link()
• get_filenames()

textpattern/include/txp_form.php

• form_list()
• form_multi_edit()
• form_create()
• form_edit()
• form_save()
• form_delete()
• formTypes()

textpattern/include/txp_image.php

• image_list()
• image_search_form()
• image_edit()
• image_insert()
• image_replace()
• thumbnail_insert()
• image_save()
• image_delete()
• image_change_pageby()
• thumb_ui()
• thumbnail_create()
• image_data()

textpattern/include/txp_import.php

• switch_tool()
• showHideFields()
• start_import()
• check_import_file()
• array_slash()
• import_section_popup()

textpattern/include/txp_link.php

• link_list()
• link_search_form()
• link_edit()
• linkcategory_popup()
• link_post()
• link_save()
• link_change_pageby()
• link_multiedit_form()
• link_multi_edit()

textpattern/include/txp_list.php

• list_list()
• list_change_pageby()
• list_search_form()
• list_multiedit_form()
• list_multi_edit()

textpattern/include/txp_log.php

• log_list()
• log_search_form()
• log_change_pageby()
• log_multiedit_form()
• log_multi_edit()

textpattern/include/txp_page.php

• page_edit()
• div_edit()
• page_edit_form()
• page_list()
• page_delete()
• page_save()
• taglinks()
• extract_div()
• div_save()

textpattern/include/txp_plugin.php

• plugin_list()
• switch_status()
• plugin_edit()
• plugin_help()
• plugin_edit_form()
• plugin_save()
• plugin_delete()
• status_link()
• plugin_verify()
• plugin_install()
• plugin_form()

textpattern/include/txp_prefs.php

• prefs_save()
• prefs_list()
• pref_func()
• text_input()
• gmtoffset_select()
• logging()
• permlinkmodes()
• urlmodes()
• commentmode()
• weeks()
• languages()
• dateformats()
• prod_levels()
• advanced_prefs()
• real_max_upload_size()
• advanced_prefs_save()
• list_languages()
• get_language()
• install_lang_key()
• get_lang_files()

textpattern/include/txp_preview.php

No functions are defined in this file.

textpattern/include/txp_section.php

• sec_section_list()
• section_create()
• section_save()
• section_delete()

textpattern/include/txp_tag.php

• tagRow()
• tb()
• tbd()
• tdb()
• key_input()
• input_id()
• input_time()
• time_pop()
• input_limit()
• input_offset()
• input_tag()
• yesno_pop()
• yesno2_pop()
• status_pop()
• section_pop()
• type_pop()
• feed_flavor_pop()
• feed_format_pop()
• article_category_pop()
• link_category_pop()
• file_category_pop()
• match_pop()
• author_pop()
• sort_pop()
• discuss_sort_pop()
• pgonly_pop()
• form_pop()
• css_pop()
• css_format_pop()
• escape_pop()
• tag_article()
• tag_article_custom()
• tag_email()
• tag_page_title()
• tag_linklist()
• tag_section_list()
• tag_category_list()
• tag_recent_articles()
• tag_related_articles()
• tag_recent_comments()
• tag_output_form()
• tag_popup()
• tag_password_protect()
• tag_search_input()
• tag_category1()
• tag_category2()
• tag_section()
• tag_author()
• tag_link_to_home()
• tag_link_to_prev()
• tag_link_to_next()
• tag_feed_link()
• tag_link_feed_link()
• tag_permlink()
• tag_newer()
• tag_older()
• tag_next_title()
• tag_sitename()
• tag_site_slogan()
• tag_prev_title()
• tag_article_image()
• tag_css()
• tag_body()
• tag_excerpt()
• tag_title()
• tag_link()
• tag_linkdesctitle()
• tag_link_description()
• tag_link_name()
• tag_link_category()
• tag_link_date()
• tag_posted()
• tag_comments_invite()
• tag_comment_permlink()
• tag_comment_time()
• tag_comment_name()
• tag_comment_email()
• tag_comment_web()
• tag_comment_message()
• tag_comment_email_input()
• tag_comment_message_input()
• tag_comment_name_input()
• tag_comment_preview()
• tag_comment_remember()
• tag_comment_submit()
• tag_comment_web_input()
• tag_comments()
• tag_comments_form()
• tag_comments_preview()
• tag_search_result_title()
• tag_search_result_excerpt()
• tag_search_result_url()
• tag_search_result_date()
• tag_lang()
• tag_breadcrumb()
• tag_image()
• tag_file_download()
• tag_file_download_list()
• tag_file_download_created()
• tag_file_download_modified()
• tag_file_download_size()
• tag_file_download_link()
• tag_file_download_name()
• tag_file_download_downloads()
• tag_file_download_category()
• tag_file_download_description()

textpattern/lib/ Directory

textpattern/lib/IXRClass.php

• class IXR_Value
  • IXR_Value()
  • calculateType()
  • getXml()
  • isStruct()
• class IXR_Message
  • IXR_Message()
  • parse()
  • tag_open()
  • cdata()
  • tag_close()
• class IXR_Server
  • IXR_Server()
  • serve()
  • call()
  • error()
  • output()
  • hasMethod()
  • setCapabilities()
  • getCapabilities()
  • setCallbacks()
  • listMethods()
  • multiCall()
• class IXR_Request
  • IXR_Request()
  • getLength()
  • getXml()
• class IXR_Client
  • IXR_Client()
  • query()
  • getResponse()
  • isError()
  • getErrorCode()
  • getErrorMessage()
• class IXR_Error
  • IXR_Error()
  • getXml()
• class IXR_Date
  • IXR_Date()
  • parseTimestamp()
  • parseIso()
  • getIso()
  • getXml()
  • getTimestamp()
• class IXR_Base64
  • IXR_Base64()
  • getXml()
• class IXR_IntrospectionServer
  • IXR_IntrospectionServer()
  • addCallback()
  • call()
  • methodSignature()
  • methodHelp()
• class IXR_ClientMulticall
  • IXR_ClientMulticall()
  • addCall()
  • query()

textpattern/lib/admin_config.php

No functions are defined in this file.

textpattern/lib/class.thumb.php

• class wet_thumb
  • wet_thumb()
  • write()
  • asTag()
• class txp_thumb
  • txp_thumb()
  • write()
• UnsharpMask()

textpattern/lib/classTextile.php

• class Textile
  • Textile()
  • TextileThis()
  • TextileRestricted()
  • pba()
  • table()
  • hasRawText()
  • fTable()
  • lists()
  • fList()
  • lT()
  • doPBr()
  • doBr()
  • block()
  • fBlock()
  • graf()
  • span()
  • fSpan()
  • links()
  • fLink()
  • getRefs()
  • refs()
  • checkRefs()
  • relURL()
  • image()
  • fImage()
  • code()
  • fCode()
  • fPre()
  • shelve()
  • retrieve()
  • incomingEntities()
  • encodeEntities()
  • fixEntities()
  • cleanWhiteSpace()
  • doSpecial()
  • fSpecial()
  • noTextile()
  • fTextile()
  • footnoteRef()
  • footnoteID()
  • glyphs()
  • iAlign()
  • hAlign()
  • vAlign()
  • encode_high()
  • decode_high()
  • cmap()
  • encode_html()
  • r_encode_html()
  • textile_popup_help()
  • txtgps()
  • dump()
  • blockLite()

textpattern/lib/txplib_db.php

• safe_pfx()
• safe_pfx_j()
• safe_query()
• safe_delete()
• safe_update()
• safe_insert()
• safe_upsert()
• safe_alter()
• safe_optimize()
• safe_repair()
• safe_field()
• safe_column()
• safe_row()
• safe_rows()
• safe_rows_start()
• safe_count()
• safe_show()
• fetch()
• getRow()
• getRows()
• startRows()
• nextRow()
• numRows()
• getThing()
• getThings()
• getCount()
• getTree()
• getTreePath()
• rebuild_tree()
• rebuild_tree_full()
• get_prefs()
• db_down()

• class DB
  • DB()

textpattern/lib/txplib_forms.php

• yesnoRadio()
• onoffRadio()
• selectInput()
• treeSelectInput()
• fInput()
• cleanfInput()
• hInput()
• sInput()
• eInput()
• checkbox()
• checkbox2()
• radio()
• form()
• fetch_editable()
• text_area()
• type_select()
• type_options()
• radio_list()

textpattern/lib/txplib_head.php

• pagetop()
• poweredit()
• areatab()
• tabber()
• tabsort()
• areas()
• navPop()
• button()

textpattern/lib/txplib_html.php

• end_page()
• column_head()
• column_multi_head()
• hCell()
• sLink()
• eLink()
• wLink()
• dLink()
• aLink()
• prevnext_link()
• PrevNextLink()
• nav_form()
• startSkelTable()
• startTable()
• endTable()
• stackRows()
• td()
• tda()
• tdtl()
• tr()
• tdcs()
• tdrs()
• fLabelCell()
• fInputCell()
• tag()
• graf()
• hed()
• href()
• strong()
• htmlPre()
• comment()
• small()
• assRow()
• assHead()
• popHelp()
• popHelpSubtle()
• popTag()
• popTagLinks()
• messenger()
• pageby_form()
• upload_form()
• search_form()
• pref_text()
• dom_attach()
• script_js()
• toggle_box()
• fieldset()

textpattern/lib/txplib_misc.php

• doArray()
• doStrip()
• doStripTags()
• doDeEnt()
• deEntBrackets()
• doSlash()
• doSpecial()
• _null()
• array_null()
• escape_title()
• escape_output()
• escape_tags()
• escape_cdata()
• gTxt()
• dmp()
• load_lang()
• load_lang_dates()
• load_lang_event()
• check_privs()
• add_privs()
• has_privs()
• require_privs()
• sizeImage()
• gps()
• gpsa()
• ps()
• psa()
• psas()
• stripPost()
• serverSet()
• pcs()
• cs()
• yes_no()
• getmicrotime()
• load_plugin()
• require_plugin()
• include_plugin()
• pluginErrorHandler()
• tagErrorHandler()
• load_plugins()
• register_callback()
• register_page_extension()
• callback_event()
• register_tab()
• getAtt()
• gAtt()
• lAtts()
• select_buttons()
• stripSpace()
• sanitizeForUrl()
• dumbDown()
• clean_url()
• noWidow()
• is_blacklisted()
• updateSitePath()
• splat()
• maxMemUsage()
• strip_rn()
• is_valid_email()
• txpMail()
• encode_mailheader()
• stripPHP()
• event_category_popup()
• event_change_pageby()
• event_multiedit_form()
• event_multi_edit()
• since()
• tz_offset()
• safe_strftime()
• safe_strtotime()
• myErrorHandler()
• find_temp_dir()
• get_uploaded_file()
• set_error_level()
• shift_uploaded_file()
• upload_get_errormsg()
• is_windows()
• is_cgi()
• is_mod_php()
• build_file_path()
• get_author_name()
• EvalElse()
• fetch_form()
• parse_form()
• fetch_category_title()
• fetch_section_title()
• update_comments_count()
• clean_comment_counts()
• markup_comment()
• update_lastmod()
• get_lastmod()
• handle_lastmod()
• set_pref()
• txp_status_header()
• txp_die()
• join_qs()
• pagelinkurl()
• in_list()
• do_list()
• doQuote()
• quote_list()
• trace_add()
• article_push()
• article_pop()
• relative_path()
• get_caller()
• getlocale()
• assert_article()
• assert_comment()
• assert_int()
• replace_relative_urls()
• show_clean_test()
• pager()
• soft_wrap()
• strip_prefix()

textpattern/lib/txplib_update.php

• install_language_from_file()
• checkUpdates()

textpattern/lib/txplib_wrapper.php

• TXP_Wrapper class
  • TXP_Wrapper()
  • deleteArticleID()
  • getArticleList()
  • getArticle()
  • getArticleID()
  • updateArticleID()
  • newArticle()
  • getSectionsList()
  • getSection()
  • getCategoryList()
  • getCategory()
  • getCategoryID()
  • getUser()
  • getTemplate()
  • setTemplate()
  • updateArticleField()
  • _setArticle()
  • _validate()
  • _sendPings()
  • _check_keys()
  • textile_main_fields()
  • format_field()

textpattern/publish/ Directory

textpattern/publish/atom.php

• atom()
• safe_hed()
• fixup_for_feed()

textpattern/publish/comment.php

• fetchComments()
• discuss()
• getNextNonce()
• getNextSecret()
• commentForm()
• popComments()
• setCookies()
• destroyCookies()
• getComment()
• saveComment()
• get_comment_evaluator()
• checkNonce()
• checkBan()
• checkCommentsAllowed()
• comments_help()
• mail_comment()

• class comment_evaluation
  • comment_evaluation()
  • add_estimate()
  • get_result()
  • get_result_message()
  • write_trace()

textpattern/publish/log.php

• log_hit()
• logit()
• insert_logit()

textpattern/publish/rss.php

• rss()
• rss_safe_hed()

textpattern/publish/search.php

• search()
• filterSearch()
• legacy_form()

textpattern/publish/taghandlers.php

• page_title()
• css()
• image()
• thumbnail()
• output_form()
• feed_link()
• link_feed_link()
• linklist()
• tpt_link()
• linkdesctitle()
• link_name()
• link_url()
• link_description()
• link_date()
• link_category()
• eE()
• email()
• password_protect()
• recent_articles()
• recent_comments()
• related_articles()
• popup()
• category_list()
• section_list()
• search_input()
• link_to_next()
• link_to_prev()
• next_title()
• prev_title()
• site_slogan()
• link_to_home()
• newer()
• older()
• text()
• article_id()
• article_url_title()
• if_article_id()
• posted()
• comments_count()
• comments_invite()
• comments_form()
• comments_error()
• if_comments_error()
• comments_annotateinvite()
• comments()
• comments_preview()
• if_comments_preview()
• comment_permlink()
• comment_id()
• comment_name()
• comment_email()
• comment_web()
• comment_time()
• comment_message()
• comment_anchor()
• message()
• author()
• if_author()
• if_article_author()
• body()
• title()
• excerpt()
• category1()
• category2()
• category()
• section()
• keywords()
• article_image()
• search_result_title()
• search_result_excerpt()
• search_result_url()
• search_result_date()
• search_result_count()
• image_index()
• image_display()
• if_comments()
• if_comments_allowed()
• if_comments_disallowed()
• if_individual_article()
• if_article_list()
• meta_keywords()
• meta_author()
• doWrap()
• doTag()
• doLabel()
• permlink()
• permlinkurl_id()
• permlinkurl()
• lang()
• formatPermLink()
• formatCommentsInvite()
• doPermlink()
• doArticleHref()
• breadcrumb()
• if_excerpt()
• if_search()
• if_category()
• if_article_category()
• if_section()
• if_article_section()
• php()
• custom_field()
• if_custom_field()
• site_url()
• img()
• error_message()
• error_status()
• if_status()
• page_url()
• if_different()
• if_first_article()
• if_last_article()
• if_plugin()
• file_download_list()
• file_download()
• file_download_link()
• fileDownloadFetchInfo()
• file_download_format_info()
• file_download_size()
• file_download_created()
• file_download_modified()
• fileDownloadFormatTime()
• file_download_id()
• file_download_name()
• file_download_category()
• file_download_downloads()
• file_download_description()

textpattern/setup/ Directory

textpattern/setup/en-gb.php

No functions are defined in this file.

textpattern/setup/index.php

• chooseLang()
• getDbInfo()
• printConfig()
• getTxpLogin()
• createTxp()
• isPost()
• makeConfig()
• fbCreate()
• postEncode()
• postDecode()
• enumPostItems()
• langs()
• setup_load_lang()
• sDoSlash()

textpattern/setup/setuplangs.php

No functions are defined in this file.

textpattern/setup/txpsql.php

No functions are defined in this file.

textpattern/update/ Directory

textpattern/update/_to_1.0.0.php

• install_lang_key()

textpattern/update/_to_4.0.2.php

No functions are defined in this file.

textpattern/update/_to_4.0.3.php

No functions are defined in this file.

textpattern/update/_to_4.0.4.php

No functions are defined in this file.

textpattern/update/_update.php

• newest_file()

Search TextBook