What developers can build on: hooks, shortcodes, blocks, REST routes and WP-CLI commands, taken from each plugin’s own readme and from what this site has registered.<\/p>\n\n\n\n
\/doctorx-esign\/v1<\/code>, \/doctorx-esign\/v1\/envelopes\/(?P<id>\d+)<\/code>, \/doctorx-esign\/v1\/envelopes\/(?P<id>\d+)\/draft<\/code>, \/doctorx-esign\/v1\/envelopes\/(?P<id>\d+)\/apply-layout<\/code>, \/doctorx-esign\/v1\/envelopes\/(?P<id>\d+)\/send<\/code>, \/doctorx-esign\/v1\/portal\/open<\/code>, \/doctorx-esign\/v1\/portal\/code<\/code>, \/doctorx-esign\/v1\/portal\/verify<\/code>, \/doctorx-esign\/v1\/portal\/document<\/code>, \/doctorx-esign\/v1\/portal\/fields<\/code>, \/doctorx-esign\/v1\/portal\/submit<\/code>, \/doctorx-esign\/v1\/portal\/decline<\/code> and 2 more<\/li><\/ul>\n\n\n\nAdd-ons (for example an industry add-on with its own forms) can build on DoctorX e-Sign without changing it. Wait for the doctorx_esign_loaded<\/code> action, then use:<\/p>\nPlacement templates (recognise an uploaded PDF and lay out its fields, coordinates only)<\/p>\n
\ndoctorx_esign_register_placement_matcher( $id, $callback, $priority )<\/code> \u2014 your callback receives the document facts (envelope_id<\/code>, title<\/code>, file_name<\/code>, sha256<\/code>, page_count<\/code>, page_sizes<\/code>, info<\/code> (PDF properties), text<\/code> (callable: best-effort text of the first pages), bytes<\/code> (callable)) and returns null<\/code> or a layout: id<\/code>, label<\/code>, roles<\/code> (key<\/code>, label<\/code>, routing_order<\/code>), fields<\/code> (type<\/code>, page<\/code> from 1, x<\/code>, y<\/code>, w<\/code>, h<\/code> as fractions of the displayed page from the top-left corner, role<\/code>, required<\/code>, label<\/code>). The sender sees "This document was recognised as \u2026" with an Apply button.<\/li>\n- Filters
doctorx_esign_placement_matchers<\/code> and doctorx_esign_placement_match<\/code> (final say over the recognised layout).<\/li>\ndoctorx_esign_apply_field_placements( $envelope_id, $layout, $args )<\/code> \u2014 apply a layout to a draft; signers are matched by role key and missing ones are created. Action doctorx_esign_placements_applied<\/code>.<\/li>\ndoctorx_esign_replace_draft_pdf( $envelope_id, $bytes, $args )<\/code> \u2014 replace a draft's PDF (for example after filling in blanks or appending pages); signers and fields stay, fields on pages that no longer exist (or from remove_fields_from_page<\/code> on) are removed, and the change is recorded in the audit trail. Action doctorx_esign_draft_pdf_replaced<\/code>.<\/li>\n<\/ul>\nDocument templates, field types, identity checks<\/p>\n
\n- Filter
doctorx_esign_document_templates<\/code> \u2014 documents offered on "Send a document" (label<\/code>, file<\/code> = path to a PDF you provide, optional roles<\/code> and fields<\/code>).<\/li>\n- Filter
doctorx_esign_field_types<\/code> \u2014 add field types (label<\/code>, input<\/code>, kind<\/code> image\/text\/check, default width<\/code>\/height<\/code>, required<\/code>, auto<\/code>, validate<\/code>).<\/li>\n- Filter
doctorx_esign_verification_methods<\/code> \u2014 add signer identity checks (label<\/code>, input<\/code>, requires<\/code>, available<\/code>, send<\/code>, verify<\/code>, prompt<\/code> callbacks).<\/li>\n<\/ul>\nWorkflow<\/p>\n
\n- Filter
doctorx_esign_pre_send_checks<\/code> \u2014 return extra messages to block sending, shown to the sender.<\/li>\ndoctorx_esign_log_event( $envelope_id, $event, $details, $signer_id )<\/code> \u2014 add an audit-trail entry (it also appears on the certificate). Filter doctorx_esign_audit_event_labels<\/code> for labels; action doctorx_esign_audit_event_logged<\/code>.<\/li>\n- Filter
doctorx_esign_certificate_sections<\/code> \u2014 change the completion certificate content.<\/li>\n- Actions
doctorx_esign_envelope_created<\/code>, _sent<\/code>, _signer_signed<\/code>, _completed<\/code>, _declined<\/code>, _voided<\/code>, _expired<\/code>, _deleted<\/code>.<\/li>\ndoctorx_esign_create_envelope()<\/code>, doctorx_esign_get_envelope()<\/code>, doctorx_esign_get_meta()<\/code> \/ doctorx_esign_update_meta()<\/code> (your own data on a document), doctorx_esign_completed_pdf()<\/code>, doctorx_esign_completion_certificate_pdf()<\/code> (the separate certificate, when the document's owner did not allow adding pages).<\/li>\n- Action
doctorx_esign_privacy_erased<\/code> \u2014 after a personal data erasure request was handled.<\/li>\n<\/ul>\nProtected PDFs<\/p>\n
\nDoctorX_ESign_PDF_Reader::permissions()<\/code> says what the owner allows (modify<\/code>, annotate<\/code>, fill<\/code>, assemble<\/code>); DoctorX_ESign_PDF_Writer::can()<\/code> asks the same. In a protected file overlay_page()<\/code> needs modify<\/code> and append_page()<\/code> needs assemble<\/code>; they throw a DoctorX_ESign_PDF_Exception<\/code> with a readable message otherwise.<\/li>\nDoctorX_ESign_PDF_Builder::place_values( $writer, $fields )<\/code> adds values (text, check marks, images) the way the permissions allow: drawn onto the page, as annotations, or as read-only form fields. Use it to write into a draft that may be protected.<\/li>\n<\/ul>\nAdmin<\/p>\n
\n- Filter
doctorx_esign_settings_tabs<\/code> \u2014 add a settings tab (label<\/code>, render<\/code>, save<\/code>; nonce and capability are checked for you).<\/li>\n- Action
doctorx_esign_admin_menu<\/code> \u2014 add pages under the e-Sign menu. Action doctorx_esign_envelope_details<\/code> \u2014 add a panel to a document's details screen. Action doctorx_esign_editor_panels<\/code> \u2014 add a panel above the field editor of a draft.<\/li>\n- Other filters:
doctorx_esign_email<\/code>, doctorx_esign_user_can_access<\/code>, doctorx_esign_client_ip<\/code>, doctorx_esign_signature_subfilter<\/code>, doctorx_esign_tsa_request_args<\/code>, doctorx_esign_portal_csp<\/code>, doctorx_esign_storage_base_dir<\/code>, doctorx_esign_normalize_phone<\/code>.<\/li>\n<\/ul>\nCapabilities: drx_esign_send<\/code>, drx_esign_view_all<\/code>, drx_esign_manage<\/code>.<\/p>\nSelf-tests that run with plain PHP (no WordPress): php tests\/selftest-signing.php<\/code>, php tests\/selftest-encryption.php<\/code>, php tests\/selftest-storage.php<\/code> and php tests\/selftest-workflow.php<\/code>.<\/p>\nThird-party code<\/h3>\n\n- PDF.js 3.11.174 by Mozilla, Apache License 2.0 (assets\/vendor\/pdfjs\/LICENSE), bundled; used to show PDFs in the editor and on the signing page.<\/li>\n
- Dancing Script, Alex Brush, Great Vibes and Sacramento fonts, SIL Open Font License 1.1 (assets\/fonts\/OFL-*.txt), for typed signatures.<\/li>\n
- Character widths of the standard Helvetica fonts from the Adobe Core 14 font metrics.<\/li>\n<\/ul>\n\n\n","protected":false},"excerpt":{"rendered":"
What developers can build on: hooks, shortcodes, blocks, REST routes and WP-CLI commands, taken from each plugin’s own readme and from what this site has registered. DoctorX e-Sign REST routes: \/doctorx-esign\/v1, \/doctorx-esign\/v1\/envelopes\/(?P<id>\d+), \/doctorx-esign\/v1\/envelopes\/(?P<id>\d+)\/draft, \/doctorx-esign\/v1\/envelopes\/(?P<id>\d+)\/apply-layout, \/doctorx-esign\/v1\/envelopes\/(?P<id>\d+)\/send, \/doctorx-esign\/v1\/portal\/open, \/doctorx-esign\/v1\/portal\/code, \/doctorx-esign\/v1\/portal\/verify, \/doctorx-esign\/v1\/portal\/document, \/doctorx-esign\/v1\/portal\/fields, \/doctorx-esign\/v1\/portal\/submit, \/doctorx-esign\/v1\/portal\/decline and 2 more Add-ons (for example an industry add-on with its own forms) […]<\/p>\n","protected":false},"author":0,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-15","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/demo.doctorx.ca\/esign\/wp-json\/wp\/v2\/pages\/15","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/demo.doctorx.ca\/esign\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/demo.doctorx.ca\/esign\/wp-json\/wp\/v2\/types\/page"}],"replies":[{"embeddable":true,"href":"https:\/\/demo.doctorx.ca\/esign\/wp-json\/wp\/v2\/comments?post=15"}],"version-history":[{"count":2,"href":"https:\/\/demo.doctorx.ca\/esign\/wp-json\/wp\/v2\/pages\/15\/revisions"}],"predecessor-version":[{"id":18,"href":"https:\/\/demo.doctorx.ca\/esign\/wp-json\/wp\/v2\/pages\/15\/revisions\/18"}],"wp:attachment":[{"href":"https:\/\/demo.doctorx.ca\/esign\/wp-json\/wp\/v2\/media?parent=15"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}