fonts
5 years ago
scripts
5 years ago
styles
5 years ago
global.html
21 hours ago
index.html
21 hours ago
module-wpcf7cf.html
5 years ago
scripts.js.html
21 hours ago
scripts_es6.js.html
4 years ago
wpcf7cf.html
21 hours ago
wpcf7cfApi.html
5 years ago
global.html
810 lines
| 1 | <!DOCTYPE html> |
| 2 | <html lang="en"> |
| 3 | <head> |
| 4 | <meta charset="utf-8"> |
| 5 | <title>JSDoc: Global</title> |
| 6 | |
| 7 | <script src="scripts/prettify/prettify.js"> </script> |
| 8 | <script src="scripts/prettify/lang-css.js"> </script> |
| 9 | <!--[if lt IE 9]> |
| 10 | <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> |
| 11 | <![endif]--> |
| 12 | <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> |
| 13 | <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> |
| 14 | </head> |
| 15 | |
| 16 | <body> |
| 17 | |
| 18 | <div id="main"> |
| 19 | |
| 20 | <h1 class="page-title">Global</h1> |
| 21 | |
| 22 | |
| 23 | |
| 24 | |
| 25 | |
| 26 | |
| 27 | <section> |
| 28 | |
| 29 | <header> |
| 30 | |
| 31 | <h2></h2> |
| 32 | |
| 33 | |
| 34 | </header> |
| 35 | |
| 36 | <article> |
| 37 | <div class="container-overview"> |
| 38 | |
| 39 | |
| 40 | |
| 41 | |
| 42 | |
| 43 | |
| 44 | <dl class="details"> |
| 45 | |
| 46 | |
| 47 | |
| 48 | |
| 49 | |
| 50 | |
| 51 | |
| 52 | |
| 53 | |
| 54 | |
| 55 | |
| 56 | |
| 57 | |
| 58 | |
| 59 | |
| 60 | |
| 61 | |
| 62 | |
| 63 | |
| 64 | |
| 65 | |
| 66 | |
| 67 | |
| 68 | |
| 69 | |
| 70 | |
| 71 | |
| 72 | |
| 73 | |
| 74 | |
| 75 | |
| 76 | |
| 77 | </dl> |
| 78 | |
| 79 | |
| 80 | |
| 81 | |
| 82 | </div> |
| 83 | |
| 84 | |
| 85 | |
| 86 | |
| 87 | |
| 88 | |
| 89 | |
| 90 | |
| 91 | |
| 92 | |
| 93 | |
| 94 | |
| 95 | |
| 96 | |
| 97 | |
| 98 | |
| 99 | <h3 class="subsection-title">Methods</h3> |
| 100 | |
| 101 | |
| 102 | |
| 103 | |
| 104 | |
| 105 | |
| 106 | |
| 107 | <h4 class="name" id="all"><span class="type-signature"></span>all<span class="signature">()</span><span class="type-signature"> → {Object}</span></h4> |
| 108 | |
| 109 | |
| 110 | |
| 111 | |
| 112 | |
| 113 | |
| 114 | <div class="description"> |
| 115 | <p>Get all field values as an object { fieldName: numericValue }.</p> |
| 116 | </div> |
| 117 | |
| 118 | |
| 119 | |
| 120 | |
| 121 | |
| 122 | |
| 123 | |
| 124 | |
| 125 | |
| 126 | |
| 127 | |
| 128 | |
| 129 | |
| 130 | <dl class="details"> |
| 131 | |
| 132 | |
| 133 | |
| 134 | |
| 135 | |
| 136 | |
| 137 | |
| 138 | |
| 139 | |
| 140 | |
| 141 | |
| 142 | |
| 143 | |
| 144 | |
| 145 | |
| 146 | |
| 147 | |
| 148 | |
| 149 | |
| 150 | |
| 151 | |
| 152 | |
| 153 | |
| 154 | |
| 155 | |
| 156 | |
| 157 | <dt class="tag-source">Source:</dt> |
| 158 | <dd class="tag-source"><ul class="dummy"><li> |
| 159 | <a href="scripts.js.html">scripts.js</a>, <a href="scripts.js.html#line1751">line 1751</a> |
| 160 | </li></ul></dd> |
| 161 | |
| 162 | |
| 163 | |
| 164 | |
| 165 | |
| 166 | |
| 167 | |
| 168 | </dl> |
| 169 | |
| 170 | |
| 171 | |
| 172 | |
| 173 | |
| 174 | |
| 175 | |
| 176 | |
| 177 | |
| 178 | |
| 179 | |
| 180 | |
| 181 | |
| 182 | |
| 183 | |
| 184 | <h5>Returns:</h5> |
| 185 | |
| 186 | |
| 187 | |
| 188 | |
| 189 | <dl> |
| 190 | <dt> |
| 191 | Type |
| 192 | </dt> |
| 193 | <dd> |
| 194 | |
| 195 | <span class="param-type">Object</span> |
| 196 | |
| 197 | |
| 198 | </dd> |
| 199 | </dl> |
| 200 | |
| 201 | |
| 202 | |
| 203 | |
| 204 | |
| 205 | |
| 206 | |
| 207 | |
| 208 | |
| 209 | |
| 210 | |
| 211 | |
| 212 | |
| 213 | <h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(name)</span><span class="type-signature"> → {Number}</span></h4> |
| 214 | |
| 215 | |
| 216 | |
| 217 | |
| 218 | |
| 219 | |
| 220 | <div class="description"> |
| 221 | <p>Get the numeric value of a field. Auto-resolves repeater suffix.</p> |
| 222 | </div> |
| 223 | |
| 224 | |
| 225 | |
| 226 | |
| 227 | |
| 228 | |
| 229 | |
| 230 | |
| 231 | |
| 232 | <h5>Parameters:</h5> |
| 233 | |
| 234 | |
| 235 | <table class="params"> |
| 236 | <thead> |
| 237 | <tr> |
| 238 | |
| 239 | <th>Name</th> |
| 240 | |
| 241 | |
| 242 | <th>Type</th> |
| 243 | |
| 244 | |
| 245 | |
| 246 | |
| 247 | |
| 248 | <th class="last">Description</th> |
| 249 | </tr> |
| 250 | </thead> |
| 251 | |
| 252 | <tbody> |
| 253 | |
| 254 | |
| 255 | <tr> |
| 256 | |
| 257 | <td class="name"><code>name</code></td> |
| 258 | |
| 259 | |
| 260 | <td class="type"> |
| 261 | |
| 262 | |
| 263 | <span class="param-type">String</span> |
| 264 | |
| 265 | |
| 266 | |
| 267 | </td> |
| 268 | |
| 269 | |
| 270 | |
| 271 | |
| 272 | |
| 273 | <td class="description last"><p>The original field name</p></td> |
| 274 | </tr> |
| 275 | |
| 276 | |
| 277 | </tbody> |
| 278 | </table> |
| 279 | |
| 280 | |
| 281 | |
| 282 | |
| 283 | |
| 284 | |
| 285 | <dl class="details"> |
| 286 | |
| 287 | |
| 288 | |
| 289 | |
| 290 | |
| 291 | |
| 292 | |
| 293 | |
| 294 | |
| 295 | |
| 296 | |
| 297 | |
| 298 | |
| 299 | |
| 300 | |
| 301 | |
| 302 | |
| 303 | |
| 304 | |
| 305 | |
| 306 | |
| 307 | |
| 308 | |
| 309 | |
| 310 | |
| 311 | |
| 312 | <dt class="tag-source">Source:</dt> |
| 313 | <dd class="tag-source"><ul class="dummy"><li> |
| 314 | <a href="scripts.js.html">scripts.js</a>, <a href="scripts.js.html#line1734">line 1734</a> |
| 315 | </li></ul></dd> |
| 316 | |
| 317 | |
| 318 | |
| 319 | |
| 320 | |
| 321 | |
| 322 | |
| 323 | </dl> |
| 324 | |
| 325 | |
| 326 | |
| 327 | |
| 328 | |
| 329 | |
| 330 | |
| 331 | |
| 332 | |
| 333 | |
| 334 | |
| 335 | |
| 336 | |
| 337 | |
| 338 | |
| 339 | <h5>Returns:</h5> |
| 340 | |
| 341 | |
| 342 | |
| 343 | |
| 344 | <dl> |
| 345 | <dt> |
| 346 | Type |
| 347 | </dt> |
| 348 | <dd> |
| 349 | |
| 350 | <span class="param-type">Number</span> |
| 351 | |
| 352 | |
| 353 | </dd> |
| 354 | </dl> |
| 355 | |
| 356 | |
| 357 | |
| 358 | |
| 359 | |
| 360 | |
| 361 | |
| 362 | |
| 363 | |
| 364 | |
| 365 | |
| 366 | |
| 367 | |
| 368 | <h4 class="name" id="raw"><span class="type-signature"></span>raw<span class="signature">(name)</span><span class="type-signature"> → {String|Array}</span></h4> |
| 369 | |
| 370 | |
| 371 | |
| 372 | |
| 373 | |
| 374 | |
| 375 | <div class="description"> |
| 376 | <p>Get the raw value of a field. Auto-resolves repeater suffix.</p> |
| 377 | </div> |
| 378 | |
| 379 | |
| 380 | |
| 381 | |
| 382 | |
| 383 | |
| 384 | |
| 385 | |
| 386 | |
| 387 | <h5>Parameters:</h5> |
| 388 | |
| 389 | |
| 390 | <table class="params"> |
| 391 | <thead> |
| 392 | <tr> |
| 393 | |
| 394 | <th>Name</th> |
| 395 | |
| 396 | |
| 397 | <th>Type</th> |
| 398 | |
| 399 | |
| 400 | |
| 401 | |
| 402 | |
| 403 | <th class="last">Description</th> |
| 404 | </tr> |
| 405 | </thead> |
| 406 | |
| 407 | <tbody> |
| 408 | |
| 409 | |
| 410 | <tr> |
| 411 | |
| 412 | <td class="name"><code>name</code></td> |
| 413 | |
| 414 | |
| 415 | <td class="type"> |
| 416 | |
| 417 | |
| 418 | <span class="param-type">String</span> |
| 419 | |
| 420 | |
| 421 | |
| 422 | </td> |
| 423 | |
| 424 | |
| 425 | |
| 426 | |
| 427 | |
| 428 | <td class="description last"><p>The original field name</p></td> |
| 429 | </tr> |
| 430 | |
| 431 | |
| 432 | </tbody> |
| 433 | </table> |
| 434 | |
| 435 | |
| 436 | |
| 437 | |
| 438 | |
| 439 | |
| 440 | <dl class="details"> |
| 441 | |
| 442 | |
| 443 | |
| 444 | |
| 445 | |
| 446 | |
| 447 | |
| 448 | |
| 449 | |
| 450 | |
| 451 | |
| 452 | |
| 453 | |
| 454 | |
| 455 | |
| 456 | |
| 457 | |
| 458 | |
| 459 | |
| 460 | |
| 461 | |
| 462 | |
| 463 | |
| 464 | |
| 465 | |
| 466 | |
| 467 | <dt class="tag-source">Source:</dt> |
| 468 | <dd class="tag-source"><ul class="dummy"><li> |
| 469 | <a href="scripts.js.html">scripts.js</a>, <a href="scripts.js.html#line1742">line 1742</a> |
| 470 | </li></ul></dd> |
| 471 | |
| 472 | |
| 473 | |
| 474 | |
| 475 | |
| 476 | |
| 477 | |
| 478 | </dl> |
| 479 | |
| 480 | |
| 481 | |
| 482 | |
| 483 | |
| 484 | |
| 485 | |
| 486 | |
| 487 | |
| 488 | |
| 489 | |
| 490 | |
| 491 | |
| 492 | |
| 493 | |
| 494 | <h5>Returns:</h5> |
| 495 | |
| 496 | |
| 497 | |
| 498 | |
| 499 | <dl> |
| 500 | <dt> |
| 501 | Type |
| 502 | </dt> |
| 503 | <dd> |
| 504 | |
| 505 | <span class="param-type">String</span> |
| 506 | | |
| 507 | |
| 508 | <span class="param-type">Array</span> |
| 509 | |
| 510 | |
| 511 | </dd> |
| 512 | </dl> |
| 513 | |
| 514 | |
| 515 | |
| 516 | |
| 517 | |
| 518 | |
| 519 | |
| 520 | |
| 521 | |
| 522 | |
| 523 | |
| 524 | |
| 525 | |
| 526 | <h4 class="name" id="suffix"><span class="type-signature"></span>suffix<span class="signature">()</span><span class="type-signature"> → {String}</span></h4> |
| 527 | |
| 528 | |
| 529 | |
| 530 | |
| 531 | |
| 532 | |
| 533 | <div class="description"> |
| 534 | <p>Get the repeater suffix for this calculated field's context.</p> |
| 535 | </div> |
| 536 | |
| 537 | |
| 538 | |
| 539 | |
| 540 | |
| 541 | |
| 542 | |
| 543 | |
| 544 | |
| 545 | |
| 546 | |
| 547 | |
| 548 | |
| 549 | <dl class="details"> |
| 550 | |
| 551 | |
| 552 | |
| 553 | |
| 554 | |
| 555 | |
| 556 | |
| 557 | |
| 558 | |
| 559 | |
| 560 | |
| 561 | |
| 562 | |
| 563 | |
| 564 | |
| 565 | |
| 566 | |
| 567 | |
| 568 | |
| 569 | |
| 570 | |
| 571 | |
| 572 | |
| 573 | |
| 574 | |
| 575 | |
| 576 | <dt class="tag-source">Source:</dt> |
| 577 | <dd class="tag-source"><ul class="dummy"><li> |
| 578 | <a href="scripts.js.html">scripts.js</a>, <a href="scripts.js.html#line1791">line 1791</a> |
| 579 | </li></ul></dd> |
| 580 | |
| 581 | |
| 582 | |
| 583 | |
| 584 | |
| 585 | |
| 586 | |
| 587 | </dl> |
| 588 | |
| 589 | |
| 590 | |
| 591 | |
| 592 | |
| 593 | |
| 594 | |
| 595 | |
| 596 | |
| 597 | |
| 598 | |
| 599 | |
| 600 | |
| 601 | |
| 602 | |
| 603 | <h5>Returns:</h5> |
| 604 | |
| 605 | |
| 606 | |
| 607 | |
| 608 | <dl> |
| 609 | <dt> |
| 610 | Type |
| 611 | </dt> |
| 612 | <dd> |
| 613 | |
| 614 | <span class="param-type">String</span> |
| 615 | |
| 616 | |
| 617 | </dd> |
| 618 | </dl> |
| 619 | |
| 620 | |
| 621 | |
| 622 | |
| 623 | |
| 624 | |
| 625 | |
| 626 | |
| 627 | |
| 628 | |
| 629 | |
| 630 | |
| 631 | |
| 632 | <h4 class="name" id="sum"><span class="type-signature"></span>sum<span class="signature">(name)</span><span class="type-signature"> → {Number}</span></h4> |
| 633 | |
| 634 | |
| 635 | |
| 636 | |
| 637 | |
| 638 | |
| 639 | <div class="description"> |
| 640 | <p>Sum a field's numeric value across all repeater subs. |
| 641 | E.g. fields.sum('quantity') sums quantity__1, quantity__2, etc.</p> |
| 642 | </div> |
| 643 | |
| 644 | |
| 645 | |
| 646 | |
| 647 | |
| 648 | |
| 649 | |
| 650 | |
| 651 | |
| 652 | <h5>Parameters:</h5> |
| 653 | |
| 654 | |
| 655 | <table class="params"> |
| 656 | <thead> |
| 657 | <tr> |
| 658 | |
| 659 | <th>Name</th> |
| 660 | |
| 661 | |
| 662 | <th>Type</th> |
| 663 | |
| 664 | |
| 665 | |
| 666 | |
| 667 | |
| 668 | <th class="last">Description</th> |
| 669 | </tr> |
| 670 | </thead> |
| 671 | |
| 672 | <tbody> |
| 673 | |
| 674 | |
| 675 | <tr> |
| 676 | |
| 677 | <td class="name"><code>name</code></td> |
| 678 | |
| 679 | |
| 680 | <td class="type"> |
| 681 | |
| 682 | |
| 683 | <span class="param-type">String</span> |
| 684 | |
| 685 | |
| 686 | |
| 687 | </td> |
| 688 | |
| 689 | |
| 690 | |
| 691 | |
| 692 | |
| 693 | <td class="description last"><p>The original (unsuffixed) field name</p></td> |
| 694 | </tr> |
| 695 | |
| 696 | |
| 697 | </tbody> |
| 698 | </table> |
| 699 | |
| 700 | |
| 701 | |
| 702 | |
| 703 | |
| 704 | |
| 705 | <dl class="details"> |
| 706 | |
| 707 | |
| 708 | |
| 709 | |
| 710 | |
| 711 | |
| 712 | |
| 713 | |
| 714 | |
| 715 | |
| 716 | |
| 717 | |
| 718 | |
| 719 | |
| 720 | |
| 721 | |
| 722 | |
| 723 | |
| 724 | |
| 725 | |
| 726 | |
| 727 | |
| 728 | |
| 729 | |
| 730 | |
| 731 | |
| 732 | <dt class="tag-source">Source:</dt> |
| 733 | <dd class="tag-source"><ul class="dummy"><li> |
| 734 | <a href="scripts.js.html">scripts.js</a>, <a href="scripts.js.html#line1768">line 1768</a> |
| 735 | </li></ul></dd> |
| 736 | |
| 737 | |
| 738 | |
| 739 | |
| 740 | |
| 741 | |
| 742 | |
| 743 | </dl> |
| 744 | |
| 745 | |
| 746 | |
| 747 | |
| 748 | |
| 749 | |
| 750 | |
| 751 | |
| 752 | |
| 753 | |
| 754 | |
| 755 | |
| 756 | |
| 757 | |
| 758 | |
| 759 | <h5>Returns:</h5> |
| 760 | |
| 761 | |
| 762 | |
| 763 | |
| 764 | <dl> |
| 765 | <dt> |
| 766 | Type |
| 767 | </dt> |
| 768 | <dd> |
| 769 | |
| 770 | <span class="param-type">Number</span> |
| 771 | |
| 772 | |
| 773 | </dd> |
| 774 | </dl> |
| 775 | |
| 776 | |
| 777 | |
| 778 | |
| 779 | |
| 780 | |
| 781 | |
| 782 | |
| 783 | |
| 784 | |
| 785 | |
| 786 | |
| 787 | |
| 788 | </article> |
| 789 | |
| 790 | </section> |
| 791 | |
| 792 | |
| 793 | |
| 794 | |
| 795 | </div> |
| 796 | |
| 797 | <nav> |
| 798 | <h2><a href="index.html">Home</a></h2><h3>Namespaces</h3><ul><li><a href="wpcf7cf.html">wpcf7cf</a></li></ul><h3>Global</h3><ul><li><a href="global.html#all">all</a></li><li><a href="global.html#get">get</a></li><li><a href="global.html#raw">raw</a></li><li><a href="global.html#suffix">suffix</a></li><li><a href="global.html#sum">sum</a></li></ul> |
| 799 | </nav> |
| 800 | |
| 801 | <br class="clear"> |
| 802 | |
| 803 | <footer> |
| 804 | Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Tue Jul 07 2026 03:19:09 GMT+0200 (Central European Summer Time) |
| 805 | </footer> |
| 806 | |
| 807 | <script> prettyPrint(); </script> |
| 808 | <script src="scripts/linenumber.js"> </script> |
| 809 | </body> |
| 810 | </html> |