Skip to content

Commit b4b0eee

Browse files
authored
Merge pull request #81 from dingo-d/readme-update
Readme update
2 parents ca13889 + 388f4c3 commit b4b0eee

File tree

2 files changed

+43
-22
lines changed

2 files changed

+43
-22
lines changed

README.txt

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -520,6 +520,7 @@ execute on the checkout.
520520

521521
Usage:
522522

523+
<code>
523524
add_filter('woo_solo_api_overwrite_request_on_checkout', 'my_payment_processor_overwrite', 10, 2);
524525

525526
function my_payment_processor_overwrite($sendControl, $order) {
@@ -537,9 +538,12 @@ function my_payment_processor_overwrite($sendControl, $order) {
537538
// Default fallback.
538539
return $sendControl;
539540
}
541+
</code>
540542

543+
<code>
541544
@param string $sendControl Type of send control. Can be 'checkout' or 'status_change'.
542545
@param WC_Order $order Order object.
546+
</code>
543547

544548
--------------
545549

@@ -559,8 +563,10 @@ function my_customer_filter($customerNote, $order) {
559563
}
560564
</code>
561565

566+
<code>
562567
@param string $customerNote Existing customer note.
563568
@param WC_Order $order Order object
569+
</code>
564570

565571
--------------
566572

@@ -571,14 +577,18 @@ you can just hook to this filter and modify the request body.
571577

572578
Usage:
573579

580+
<code>
574581
add_filter('woo_solo_api_modify_request_body', 'my_customer_filter', 10, 2);
575582

576583
function my_customer_filter($requestBody, $order) {
577584
// (maybe) modify $requestBody.
578585
return $requestBody;
579586
}
587+
</code>
580588

589+
<code>
581590
@param array $requestBody Existing customer note.
591+
</code>
582592

583593
--------------
584594

@@ -598,9 +608,11 @@ function my_message_filter($emailMessage, $orderId, $email) {
598608
}
599609
</code>
600610

611+
<code>
601612
@param string $emailMessage Email message from options to filter.
602613
@param int $orderId Order ID.
603614
@param string $email Email address of the person for whom this message needs to be send to.
615+
</code>
604616

605617
--------------
606618

@@ -619,9 +631,11 @@ function my_message_filter($defaultMessage, $orderId, $email) {
619631
}
620632
</code>
621633

634+
<code>
622635
@param string $defaultMessage Email message to filter.
623636
@param int $orderId Order ID.
624637
@param string $email Email address of the person for whom this message needs to be send to.
638+
</code>
625639

626640
--------------
627641

@@ -641,8 +655,10 @@ function my_title_filter($emailTitle, $orderId) {
641655
}
642656
</code>
643657

658+
<code>
644659
@param string $emailTitle Email title.
645660
@param int $orderId Order ID.
661+
</code>
646662

647663
--------------
648664

@@ -662,8 +678,10 @@ function my_title_filter($defaultTitle, $orderId) {
662678
}
663679
</code>
664680

681+
<code>
665682
@param string $emailTitle Email title.
666683
@param int $orderId Order ID.
684+
</code>
667685

668686
--------------
669687

@@ -673,10 +691,12 @@ When email to customer is sent, maybe you want to add something more. In that
673691
case you'll probably need to modify the headers sent with the email.
674692
Default ones are
675693

694+
<code>
676695
[
677696
'MIME-Version: 1.0',
678697
'Content-Type: text/html',
679698
];
699+
</code>
680700

681701
You can add to that list.
682702

@@ -691,11 +711,13 @@ function my_custom_email_headers($headers) {
691711
}
692712
</code>
693713

714+
<code>
694715
@param array $headers Email headers to pass to wp_mail.
716+
</code>
695717

696718
--------------
697719

698-
Filter the from name set from the options
720+
Filter the 'from' name set from the options
699721

700722
Usage:
701723

@@ -708,7 +730,9 @@ function my_custom_from_name($name) {
708730
}
709731
</code>
710732

733+
<code>
711734
@param string $name Name to change in the "From" field.
735+
</code>
712736

713737
--------------
714738

@@ -730,7 +754,9 @@ function my_global_discount($globalDiscount) {
730754
}
731755
</code>
732756

757+
<code>
733758
@param int $globalDiscount The value of the global discount to apply to every item.
759+
</code>
734760

735761
--------------
736762

@@ -751,6 +777,8 @@ function my_tax_rate($taxRate, $itemData, $taxRates) {
751777
}
752778
</code>
753779

780+
<code>
754781
@param float $taxRate The value of the tax rate for the current order item.
755782
@param array $itemData The data for the current order item.
756783
@param array $taxRates The value of the tax rates for the current order item.
784+
</code>

languages/woo-solo-api-js.pot

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,7 @@
1-
#, fuzzy
21
msgid ""
32
msgstr ""
4-
"Project-Id-Version: \n"
5-
"POT-Creation-Date: \n"
6-
"PO-Revision-Date: \n"
7-
"Last-Translator: \n"
8-
"Language-Team: \n"
9-
"MIME-Version: 1.0\n"
103
"Content-Type: text/plain; charset=utf-8\n"
11-
"Content-Transfer-Encoding: 8bit\n"
12-
"X-Generator: Poedit 3.0.1\n"
4+
"X-Generator: babel-plugin-makepot\n"
135

146
#: assets/dev/scripts/const/dueDate.jsx:10
157
msgid "1 week"
@@ -265,8 +257,8 @@ msgstr ""
265257

266258
#: assets/dev/scripts/index.jsx:300
267259
msgid ""
268-
"For more details on the options you can read the official SOLO API documentation "
269-
"here: "
260+
"For more details on the options you can read the official SOLO API "
261+
"documentation here: "
270262
msgstr ""
271263

272264
#: assets/dev/scripts/index.jsx:334
@@ -377,8 +369,9 @@ msgstr ""
377369

378370
#: assets/dev/scripts/index.jsx:495
379371
msgid ""
380-
"The currency will be automatically added if the selected currency is different "
381-
"from HRK. Also, a note about conversion rate will be added to the invoice/offer."
372+
"The currency will be automatically added if the selected currency is "
373+
"different from HRK. Also, a note about conversion rate will be added to the "
374+
"invoice/offer."
382375
msgstr ""
383376

384377
#: assets/dev/scripts/index.jsx:501
@@ -431,9 +424,9 @@ msgstr ""
431424

432425
#: assets/dev/scripts/index.jsx:559
433426
msgid ""
434-
"Decide when to send the PDF of the order or invoice.On customer checkout, or "
435-
"when you approve the order in the WooCommerce admin.This will determine when the "
436-
"call to the SOLO API will be made"
427+
"Decide when to send the PDF of the order or invoice.On customer checkout, "
428+
"or when you approve the order in the WooCommerce admin.This will determine "
429+
"when the call to the SOLO API will be made"
437430
msgstr ""
438431

439432
#: assets/dev/scripts/index.jsx:565
@@ -466,8 +459,8 @@ msgstr ""
466459

467460
#: assets/dev/scripts/index.jsx:615
468461
msgid ""
469-
"<str>CAUTION</str>: This change is global, every mail send from your WordPress "
470-
"will have this 'from' name"
462+
"<str>CAUTION</str>: This change is global, every mail send from your "
463+
"WordPress will have this 'from' name"
471464
msgstr ""
472465

473466
#: assets/dev/scripts/index.jsx:630
@@ -480,8 +473,8 @@ msgstr ""
480473

481474
#: assets/dev/scripts/index.jsx:636
482475
msgid ""
483-
"Pressing the button will make a request to your Solo API account,and will list "
484-
"all the invoices you have"
476+
"Pressing the button will make a request to your Solo API account,and will "
477+
"list all the invoices you have"
485478
msgstr ""
486479

487480
#: assets/dev/scripts/index.jsx:651
@@ -530,4 +523,4 @@ msgstr ""
530523

531524
#: assets/dev/scripts/index.jsx:683
532525
msgid "Updated at"
533-
msgstr ""
526+
msgstr ""

0 commit comments

Comments
 (0)