This commit is contained in:
2024-05-20 15:37:46 +03:00
commit 00b7dbd0b7
10404 changed files with 3285853 additions and 0 deletions

View File

@ -0,0 +1,25 @@
<?php
// autoload.php @generated by Composer
if (PHP_VERSION_ID < 50600) {
if (!headers_sent()) {
header('HTTP/1.1 500 Internal Server Error');
}
$err = 'Composer 2.3.0 dropped support for autoloading on PHP <5.6 and you are running '.PHP_VERSION.', please upgrade PHP or use Composer 2.2 LTS via "composer self-update --2.2". Aborting.'.PHP_EOL;
if (!ini_get('display_errors')) {
if (PHP_SAPI === 'cli' || PHP_SAPI === 'phpdbg') {
fwrite(STDERR, $err);
} elseif (!headers_sent()) {
echo $err;
}
}
trigger_error(
$err,
E_USER_ERROR
);
}
require_once __DIR__ . '/composer/autoload_real.php';
return ComposerAutoloaderInite6b20e9b4113198d9a260118efd9778a::getLoader();

View File

@ -0,0 +1,76 @@
# Contributor Covenant Code of Conduct
## Our Pledge
In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and expression,
level of experience, education, socio-economic status, nationality, personal
appearance, race, religion, or sexual identity and orientation.
## Our Standards
Examples of behavior that contributes to creating a positive environment
include:
* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
Examples of unacceptable behavior by participants include:
* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
## Our Responsibilities
Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
## Scope
This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at hello@cmb2.io. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
## Attribution
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
[homepage]: https://www.contributor-covenant.org
For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq

View File

@ -0,0 +1,674 @@
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
The licenses for most software and other practical works are designed
to take away your freedom to share and change the works. By contrast,
the GNU General Public License is intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users. We, the Free Software Foundation, use the
GNU General Public License for most of our software; it applies also to
any other work released this way by its authors. You can apply it to
your programs, too.
When we speak of free software, we are referring to freedom, not
price. Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.
To protect your rights, we need to prevent others from denying you
these rights or asking you to surrender the rights. Therefore, you have
certain responsibilities if you distribute copies of the software, or if
you modify it: responsibilities to respect the freedom of others.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must pass on to the recipients the same
freedoms that you received. You must make sure that they, too, receive
or can get the source code. And you must show them these terms so they
know their rights.
Developers that use the GNU GPL protect your rights with two steps:
(1) assert copyright on the software, and (2) offer you this License
giving you legal permission to copy, distribute and/or modify it.
For the developers' and authors' protection, the GPL clearly explains
that there is no warranty for this free software. For both users' and
authors' sake, the GPL requires that modified versions be marked as
changed, so that their problems will not be attributed erroneously to
authors of previous versions.
Some devices are designed to deny users access to install or run
modified versions of the software inside them, although the manufacturer
can do so. This is fundamentally incompatible with the aim of
protecting users' freedom to change the software. The systematic
pattern of such abuse occurs in the area of products for individuals to
use, which is precisely where it is most unacceptable. Therefore, we
have designed this version of the GPL to prohibit the practice for those
products. If such problems arise substantially in other domains, we
stand ready to extend this provision to those domains in future versions
of the GPL, as needed to protect the freedom of users.
Finally, every program is threatened constantly by software patents.
States should not allow patents to restrict development and use of
software on general-purpose computers, but in those that do, we wish to
avoid the special danger that patents applied to a free program could
make it effectively proprietary. To prevent this, the GPL assures that
patents cannot be used to render the program non-free.
The precise terms and conditions for copying, distribution and
modification follow.
TERMS AND CONDITIONS
0. Definitions.
"This License" refers to version 3 of the GNU General Public License.
"Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.
"The Program" refers to any copyrightable work licensed under this
License. Each licensee is addressed as "you". "Licensees" and
"recipients" may be individuals or organizations.
To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy. The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.
A "covered work" means either the unmodified Program or a work based
on the Program.
To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy. Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.
To "convey" a work means any kind of propagation that enables other
parties to make or receive copies. Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.
An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License. If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.
1. Source Code.
The "source code" for a work means the preferred form of the work
for making modifications to it. "Object code" means any non-source
form of a work.
A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.
The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form. A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.
The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities. However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work. For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.
The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.
The Corresponding Source for a work in source code form is that
same work.
2. Basic Permissions.
All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met. This License explicitly affirms your unlimited
permission to run the unmodified Program. The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work. This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.
You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force. You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright. Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.
Conveying under any other circumstances is permitted solely under
the conditions stated below. Sublicensing is not allowed; section 10
makes it unnecessary.
3. Protecting Users' Legal Rights From Anti-Circumvention Law.
No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.
When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.
4. Conveying Verbatim Copies.
You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.
You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.
5. Conveying Modified Source Versions.
You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:
a) The work must carry prominent notices stating that you modified
it, and giving a relevant date.
b) The work must carry prominent notices stating that it is
released under this License and any conditions added under section
7. This requirement modifies the requirement in section 4 to
"keep intact all notices".
c) You must license the entire work, as a whole, under this
License to anyone who comes into possession of a copy. This
License will therefore apply, along with any applicable section 7
additional terms, to the whole of the work, and all its parts,
regardless of how they are packaged. This License gives no
permission to license the work in any other way, but it does not
invalidate such permission if you have separately received it.
d) If the work has interactive user interfaces, each must display
Appropriate Legal Notices; however, if the Program has interactive
interfaces that do not display Appropriate Legal Notices, your
work need not make them do so.
A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit. Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.
6. Conveying Non-Source Forms.
You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:
a) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by the
Corresponding Source fixed on a durable physical medium
customarily used for software interchange.
b) Convey the object code in, or embodied in, a physical product
(including a physical distribution medium), accompanied by a
written offer, valid for at least three years and valid for as
long as you offer spare parts or customer support for that product
model, to give anyone who possesses the object code either (1) a
copy of the Corresponding Source for all the software in the
product that is covered by this License, on a durable physical
medium customarily used for software interchange, for a price no
more than your reasonable cost of physically performing this
conveying of source, or (2) access to copy the
Corresponding Source from a network server at no charge.
c) Convey individual copies of the object code with a copy of the
written offer to provide the Corresponding Source. This
alternative is allowed only occasionally and noncommercially, and
only if you received the object code with such an offer, in accord
with subsection 6b.
d) Convey the object code by offering access from a designated
place (gratis or for a charge), and offer equivalent access to the
Corresponding Source in the same way through the same place at no
further charge. You need not require recipients to copy the
Corresponding Source along with the object code. If the place to
copy the object code is a network server, the Corresponding Source
may be on a different server (operated by you or a third party)
that supports equivalent copying facilities, provided you maintain
clear directions next to the object code saying where to find the
Corresponding Source. Regardless of what server hosts the
Corresponding Source, you remain obligated to ensure that it is
available for as long as needed to satisfy these requirements.
e) Convey the object code using peer-to-peer transmission, provided
you inform other peers where the object code and Corresponding
Source of the work are being offered to the general public at no
charge under subsection 6d.
A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.
A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling. In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage. For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product. A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.
"Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source. The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.
If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information. But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).
The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed. Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.
Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.
7. Additional Terms.
"Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law. If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.
When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it. (Additional permissions may be written to require their own
removal in certain cases when you modify the work.) You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.
Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:
a) Disclaiming warranty or limiting liability differently from the
terms of sections 15 and 16 of this License; or
b) Requiring preservation of specified reasonable legal notices or
author attributions in that material or in the Appropriate Legal
Notices displayed by works containing it; or
c) Prohibiting misrepresentation of the origin of that material, or
requiring that modified versions of such material be marked in
reasonable ways as different from the original version; or
d) Limiting the use for publicity purposes of names of licensors or
authors of the material; or
e) Declining to grant rights under trademark law for use of some
trade names, trademarks, or service marks; or
f) Requiring indemnification of licensors and authors of that
material by anyone who conveys the material (or modified versions of
it) with contractual assumptions of liability to the recipient, for
any liability that these contractual assumptions directly impose on
those licensors and authors.
All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10. If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term. If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.
If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.
Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.
8. Termination.
You may not propagate or modify a covered work except as expressly
provided under this License. Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).
However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.
Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.
Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License. If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.
9. Acceptance Not Required for Having Copies.
You are not required to accept this License in order to receive or
run a copy of the Program. Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance. However,
nothing other than this License grants you permission to propagate or
modify any covered work. These actions infringe copyright if you do
not accept this License. Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.
10. Automatic Licensing of Downstream Recipients.
Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License. You are not responsible
for enforcing compliance by third parties with this License.
An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations. If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.
You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License. For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.
11. Patents.
A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based. The
work thus licensed is called the contributor's "contributor version".
A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version. For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.
Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.
In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement). To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.
If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients. "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.
If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.
A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License. You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.
Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.
12. No Surrender of Others' Freedom.
If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License. If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all. For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.
13. Use with the GNU Affero General Public License.
Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU Affero General Public License into a single
combined work, and to convey the resulting work. The terms of this
License will continue to apply to the part which is the covered work,
but the special requirements of the GNU Affero General Public License,
section 13, concerning interaction through a network will apply to the
combination as such.
14. Revised Versions of this License.
The Free Software Foundation may publish revised and/or new versions of
the GNU General Public License from time to time. Such new versions will
be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.
Each version is given a distinguishing version number. If the
Program specifies that a certain numbered version of the GNU General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation. If the Program does not specify a version number of the
GNU General Public License, you may choose any version ever published
by the Free Software Foundation.
If the Program specifies that a proxy can decide which future
versions of the GNU General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.
Later license versions may give you additional or different
permissions. However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.
15. Disclaimer of Warranty.
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
16. Limitation of Liability.
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.
17. Interpretation of Sections 15 and 16.
If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.
END OF TERMS AND CONDITIONS
How to Apply These Terms to Your New Programs
If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.
To do so, attach the following notices to the program. It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <name of author>
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.
Also add information on how to contact you by electronic and paper mail.
If the program does terminal interaction, make it output a short
notice like this when it starts in an interactive mode:
<program> Copyright (C) <year> <name of author>
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, your program's commands
might be different; for a GUI interface, you would use an "about box".
You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU GPL, see
<https://www.gnu.org/licenses/>.
The GNU General Public License does not permit incorporating your program
into proprietary programs. If your program is a subroutine library, you
may consider it more useful to permit linking proprietary applications with
the library. If this is what you want to do, use the GNU Lesser General
Public License instead of this License. But first, please read
<https://www.gnu.org/licenses/why-not-lgpl.html>.

View File

@ -0,0 +1,84 @@
<?php
/**
* Bootstraps the CMB2 process
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2
* @license GPL-2.0+
* @link https://cmb2.io
*/
/**
* Function to encapsulate the CMB2 bootstrap process.
*
* @since 2.2.0
* @return void
*/
function cmb2_bootstrap() {
if ( is_admin() ) {
/**
* Fires on the admin side when CMB2 is included/loaded.
*
* In most cases, this should be used to add metaboxes. See example-functions.php
*/
do_action( 'cmb2_admin_init' );
}
/**
* Fires when CMB2 is included/loaded
*
* Can be used to add metaboxes if needed on the front-end or WP-API (or the front and backend).
*/
do_action( 'cmb2_init' );
/**
* For back-compat. Does the dirty-work of instantiating all the
* CMB2 instances for the cmb2_meta_boxes filter
*
* @since 2.0.2
*/
$cmb_config_arrays = apply_filters( 'cmb2_meta_boxes', array() );
foreach ( (array) $cmb_config_arrays as $cmb_config ) {
new CMB2( $cmb_config );
}
/**
* Fires after all CMB2 instances are created
*/
do_action( 'cmb2_init_before_hookup' );
/**
* Get all created metaboxes, and instantiate CMB2_Hookup
* on metaboxes which require it.
*
* @since 2.0.2
*/
foreach ( CMB2_Boxes::get_all() as $cmb ) {
/**
* Initiates the box "hookup" into WordPress.
*
* Unless the 'hookup' box property is `false`, the box will be hooked in as
* a post/user/comment/option/term box.
*
* And if the 'show_in_rest' box property is set, the box will be hooked
* into the CMB2 REST API.
*
* The dynamic portion of the hook name, $cmb->cmb_id, is the box id.
*
* @since 2.2.6
*
* @param array $cmb The CMB2 object to hookup.
*/
do_action( "cmb2_init_hookup_{$cmb->cmb_id}", $cmb );
}
/**
* Fires after CMB2 initiation process has been completed
*/
do_action( 'cmb2_after_init' );
}
/* End. That's it, folks! */

View File

@ -0,0 +1,45 @@
/*!
* CMB2 - v2.10.0 - 2022-10-27
* https://cmb2.io
* Copyright (c) 2022
* Licensed GPLv2+
*/
/*--------------------------------------------------------------
* CMB2 Display Styling
--------------------------------------------------------------*/
/* line 6, sass/partials/_display.scss */
.cmb2-colorpicker-swatch span {
display: inline-block;
width: 1em;
height: 1em;
border-radius: 1em;
float: right;
margin-top: 3px;
margin-left: 2px;
}
/* line 17, sass/partials/_display.scss */
.cmb2-code {
overflow: scroll;
}
/* line 21, sass/partials/_display.scss */
.cmb-image-display {
max-width: 100%;
height: auto;
}
/* line 26, sass/partials/_display.scss */
.cmb2-display-file-list li {
display: inline;
margin: 0 0 .5em .5em;
}
/* line 31, sass/partials/_display.scss */
.cmb2-oembed * {
max-width: 100%;
height: auto;
}
/*# sourceMappingURL=cmb2-display.css.map */

View File

@ -0,0 +1 @@
.cmb2-colorpicker-swatch span{display:inline-block;width:1em;height:1em;border-radius:1em;float:right;margin-top:3px;margin-left:2px}.cmb2-code{overflow:scroll}.cmb-image-display{max-width:100%;height:auto}.cmb2-display-file-list li{display:inline;margin:0 0 .5em .5em}.cmb2-oembed *{max-width:100%;height:auto}

View File

@ -0,0 +1,45 @@
/*!
* CMB2 - v2.10.0 - 2022-10-27
* https://cmb2.io
* Copyright (c) 2022
* Licensed GPLv2+
*/
/*--------------------------------------------------------------
* CMB2 Display Styling
--------------------------------------------------------------*/
/* line 6, sass/partials/_display.scss */
.cmb2-colorpicker-swatch span {
display: inline-block;
width: 1em;
height: 1em;
border-radius: 1em;
float: left;
margin-top: 3px;
margin-right: 2px;
}
/* line 17, sass/partials/_display.scss */
.cmb2-code {
overflow: scroll;
}
/* line 21, sass/partials/_display.scss */
.cmb-image-display {
max-width: 100%;
height: auto;
}
/* line 26, sass/partials/_display.scss */
.cmb2-display-file-list li {
display: inline;
margin: 0 .5em .5em 0;
}
/* line 31, sass/partials/_display.scss */
.cmb2-oembed * {
max-width: 100%;
height: auto;
}
/*# sourceMappingURL=cmb2-display.css.map */

View File

@ -0,0 +1,7 @@
{
"version": 3,
"mappings": "AAAA;;gEAEgE;;AAG/D,6BAAK;EACJ,OAAO,EAAE,YAAY;EACrB,KAAK,EAAE,GAAG;EACV,MAAM,EAAE,GAAG;EACX,aAAa,EAAE,GAAG;EAClB,KAAK,EAAE,IAAI;EACX,UAAU,EAAE,GAAG;EACf,YAAY,EAAE,GAAG;;;;AAInB,UAAW;EACV,QAAQ,EAAE,MAAM;;;;AAGjB,kBAAmB;EAClB,SAAS,EAAE,IAAI;EACf,MAAM,EAAE,IAAI;;;;AAGb,0BAA2B;EAC1B,OAAO,EAAE,MAAM;EACf,MAAM,EAAE,aAAa;;;;AAGtB,cAAe;EACd,SAAS,EAAE,IAAI;EACf,MAAM,EAAE,IAAI",
"sources": ["sass/partials/_display.scss"],
"names": [],
"file": "cmb2-display.css"
}

View File

@ -0,0 +1 @@
.cmb2-colorpicker-swatch span{display:inline-block;width:1em;height:1em;border-radius:1em;float:left;margin-top:3px;margin-right:2px}.cmb2-code{overflow:scroll}.cmb-image-display{max-width:100%;height:auto}.cmb2-display-file-list li{display:inline;margin:0 .5em .5em 0}.cmb2-oembed *{max-width:100%;height:auto}

File diff suppressed because it is too large Load Diff

File diff suppressed because one or more lines are too long

File diff suppressed because it is too large Load Diff

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because it is too large Load Diff

File diff suppressed because one or more lines are too long

File diff suppressed because it is too large Load Diff

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

View File

@ -0,0 +1,2 @@
<?php
// Silence is golden

View File

@ -0,0 +1 @@
@import "partials/display";

View File

@ -0,0 +1,15 @@
@import "partials/variables";
@import "partials/mixins";
@import "partials/main_wrap";
@import "partials/post_metaboxes";
@import "partials/context_metaboxes";
@import "partials/misc";
@import "partials/collapsible_ui";
@import "partials/jquery_ui";
@import "partials/char_counter";
/**
* CMB2 Frontend
*/
@import "partials/front";

View File

@ -0,0 +1,13 @@
@import "partials/variables";
@import "partials/mixins";
@import "partials/main_wrap";
@import "partials/post_metaboxes";
@import "partials/context_metaboxes";
@import "partials/options-page";
@import "partials/new_term";
@import "partials/misc";
@import "partials/sidebar_placements";
@import "partials/collapsible_ui";
@import "partials/jquery_ui";
@import "partials/char_counter";

View File

@ -0,0 +1,2 @@
<?php
// Silence is golden

View File

@ -0,0 +1,28 @@
/*--------------------------------------------------------------
* Character counter
--------------------------------------------------------------*/
.cmb2-char-counter-wrap {
margin: .5em 0 1em;
input[type="text"] {
font-size: 12px;
width: 25px;
}
&.cmb2-max-exceeded {
input[type="text"] {
border-color: $dark-red !important;
}
.cmb2-char-max-msg {
display: inline-block;
}
}
}
.cmb2-char-max-msg {
color: $dark-red;
display: none;
font-weight: 600;
margin-left: 1em;
}

View File

@ -0,0 +1,56 @@
/*--------------------------------------------------------------
* Collapsible UI
--------------------------------------------------------------*/
.cmb2-metabox {
.cmbhandle {
color: $gray;
float: right;
width: 27px;
height: 30px;
cursor: pointer;
right: -1em;
position: relative;
&:before {
content: '\f142';
right: 12px;
font: normal 20px/1 'dashicons';
speak: none;
display: inline-block;
padding: 8px 10px;
top: 0;
position: relative;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
text-decoration: none !important;
}
}
.postbox.closed {
.cmbhandle {
&:before {
content: '\f140';
}
}
}
button.dashicons-before.dashicons-no-alt.cmb-remove-group-row {
-webkit-appearance: none !important;
background: none !important;
border: none !important;
position: absolute;
left: 0;
top: .5em;
line-height: 1em;
padding: 2px 6px 3px;
opacity: .5;
&:not([disabled]) {
cursor: pointer;
color: $dark-red;
opacity: 1;
&:hover {
color: $red;
}
}
}
}

View File

@ -0,0 +1,111 @@
/*--------------------------------------------------------------
* Context Metaboxes
--------------------------------------------------------------*/
/* Metabox collapse arrow indicators */
.js .cmb2-postbox.context-box {
.handlediv {
text-align: center;
}
.toggle-indicator {
&:before {
content: "\f142";
display: inline-block;
font: normal 20px/1 dashicons;
speak: none;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
text-decoration: none !important;
}
}
&.closed {
.toggle-indicator {
&:before {
content: "\f140";
}
}
}
}
.cmb2-postbox.context-box {
margin-bottom: 10px;
&.context-before_permalink-box {
margin-top: 10px;
}
&.context-after_title-box {
margin-top: 10px;
}
&.context-after_editor-box {
margin-top: 20px;
margin-bottom: 0;
}
&.context-form_top-box {
margin-top: 10px;
.hndle {
font-size: 14px;
padding: 8px 12px;
margin: 0;
line-height: 1.4;
}
}
.hndle {
cursor: auto;
}
}
.cmb2-context-wrap {
margin-top: 10px;
&.cmb2-context-wrap-form_top {
margin-right: 300px;
width: auto;
}
&.cmb2-context-wrap-no-title {
.cmb2-metabox {
padding: 10px;
}
}
.cmb-th {
padding: 0 2% 0 0;
width: 18%;
}
.cmb-td {
width: 80%;
padding: 0;
}
.cmb-row {
margin-bottom: 10px;
&:last-of-type {
margin-bottom: 0;
}
}
}
/* one column on the post write/edit screen */
@media only screen and (max-width: 850px) {
.cmb2-context-wrap.cmb2-context-wrap-form_top {
margin-right: 0;
}
}

View File

@ -0,0 +1,34 @@
/*--------------------------------------------------------------
* CMB2 Display Styling
--------------------------------------------------------------*/
.cmb2-colorpicker-swatch {
span {
display: inline-block;
width: 1em;
height: 1em;
border-radius: 1em;
float: left;
margin-top: 3px;
margin-right: 2px;
}
}
.cmb2-code {
overflow: scroll;
}
.cmb-image-display {
max-width: 100%;
height: auto;
}
.cmb2-display-file-list li {
display: inline;
margin: 0 .5em .5em 0;
}
.cmb2-oembed * {
max-width: 100%;
height: auto;
}

View File

@ -0,0 +1,60 @@
/*--------------------------------------------------------------
* CMB2 Frontend
--------------------------------------------------------------*/
.closed .inside {
display: none;
}
.cmb-repeatable-grouping {
position: relative;
.cmb-group-title {
margin-left: -1em;
margin-right: -1em;
min-height: 1.5em;
}
h3 {
font-size: 14px;
padding: 8px 12px;
margin: 0;
line-height: 1.4;
}
}
.cmb-repeatable-group {
&.repeatable .cmb-group-title {
padding-left: 2.2em;
}
&.non-repeatable .cmb-group-title {
padding-left: 12px;
}
}
.cmb-type-group .cmb-row .cmbhandle {
right: 0;
position: absolute;
}
.cmb-spinner {
background: url(/wp-admin/images/spinner.gif) no-repeat;
-webkit-background-size: 20px 20px;
background-size: 20px 20px;
display: none;
float: right;
vertical-align: middle;
opacity: 0.7;
filter: alpha(opacity=70);
width: 20px;
height: 20px;
margin: 4px 10px 0;
}
.cmb2-char-max-msg {
display: none;
}

View File

@ -0,0 +1,457 @@
/*
* jQuery UI CSS Framework 1.8.16
*
* Copyright 2011, AUTHORS.txt (http://jqueryui.com/about)
* Dual licensed under the MIT or GPL Version 2 licenses.
* http://jquery.org/license
*
* http://docs.jquery.com/UI/Theming/API
*
* WordPress Styles adopted from "jQuery UI Datepicker CSS for WordPress"
* https://github.com/stuttter/wp-datepicker-styling
*
*/
* html .cmb2-element.ui-helper-clearfix {
height:1%;
}
$weekend: #f4f4f4;
$freshblue: #00a0d2;
$freshdark: #32373c;
$freshdarkblue: #0073aa;
.cmb2-element.ui-datepicker, .cmb2-element .ui-datepicker {
padding: 0;
margin: 0;
-webkit-border-radius: 0;
-moz-border-radius: 0;
border-radius: 0;
background-color: #fff;
border: 1px solid #dfdfdf;
border-top: none;
-webkit-box-shadow: 0 3px 6px rgba(0, 0, 0, 0.075);
box-shadow: 0 3px 6px rgba(0, 0, 0, 0.075);
min-width: 17em;
width: auto;
* {
padding: 0;
font-family: "Open Sans", sans-serif;
-webkit-border-radius: 0;
-moz-border-radius: 0;
border-radius: 0;
}
table {
font-size: 13px;
margin: 0;
border: none;
border-collapse: collapse;
}
.ui-widget-header,
.ui-datepicker-header {
background-image: none;
border: none;
color: #fff;
font-weight: normal;
}
.ui-datepicker-header .ui-state-hover {
background: transparent;
border-color: transparent;
cursor: pointer;
}
.ui-datepicker-title {
margin: 0;
padding: 10px 0;
color: #fff;
font-size: 14px;
line-height: 14px;
text-align: center;
select {
margin-top: -8px;
margin-bottom: -8px;
}
}
.ui-datepicker-prev,
.ui-datepicker-next {
position: relative;
top: 0;
height: 34px;
width: 34px;
}
.ui-state-hover.ui-datepicker-prev,
.ui-state-hover.ui-datepicker-next {
border: none;
}
.ui-datepicker-prev,
.ui-datepicker-prev-hover {
left: 0;
}
.ui-datepicker-next,
.ui-datepicker-next-hover {
right: 0;
}
.ui-datepicker-next span,
.ui-datepicker-prev span {
display: none;
}
.ui-datepicker-prev {
float: left;
}
.ui-datepicker-next {
float: right;
}
.ui-datepicker-prev:before,
.ui-datepicker-next:before {
font: normal 20px/34px 'dashicons';
padding-left: 7px;
color: #fff;
speak: none;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale;
width: 34px;
height: 34px;
}
.ui-datepicker-prev:before {
content: '\f341';
}
.ui-datepicker-next:before {
content: '\f345';
}
.ui-datepicker-prev-hover:before,
.ui-datepicker-next-hover:before {
opacity: 0.7;
}
select.ui-datepicker-month,
select.ui-datepicker-year {
width: 33%;
background: transparent;
border-color: transparent;
box-shadow: none;
color: #fff;
option {
color: #333;
}
}
thead {
color: #fff;
font-weight: 600;
th {
font-weight: normal;
}
}
th {
padding: 10px;
}
td {
padding: 0;
border: 1px solid $weekend;
}
td.ui-datepicker-other-month {
border: transparent;
}
td.ui-datepicker-week-end {
background-color: $weekend;
border: 1px solid $weekend;
&.ui-datepicker-today {
-webkit-box-shadow: inset 0px 0px 1px 0px rgba(0, 0, 0, 0.1);
-moz-box-shadow: inset 0px 0px 1px 0px rgba(0, 0, 0, 0.1);
box-shadow: inset 0px 0px 1px 0px rgba(0, 0, 0, 0.1);
}
}
td.ui-datepicker-today {
background-color: #f0f0c0;
}
td.ui-datepicker-current-day {
background: #bbdd88;
}
td .ui-state-default {
background: transparent;
border: none;
text-align: center;
text-decoration: none;
width: auto;
display: block;
padding: 5px 10px;
font-weight: normal;
color: #444;
}
td.ui-state-disabled .ui-state-default {
opacity: 0.5;
}
/* Default Color Scheme */
.ui-widget-header,
.ui-datepicker-header {
background: $freshblue;
}
thead {
background: $freshdark;
}
td .ui-state-hover, td .ui-state-active {
background: $freshdarkblue;
color: #fff;
}
.ui-timepicker-div {
font-size: 14px;
dl {
text-align: left;
padding: 0 .6em;
dt {
float: left;
clear:left;
padding: 0 0 0 5px;
}
dd {
margin: 0 10px 10px 40%;
select {
width: 100%;
}
}
}
+ .ui-datepicker-buttonpane {
padding: .6em;
text-align: left;
.button-primary, .button-secondary {
padding: 0 10px 1px;
-webkit-border-radius: 3px;
-moz-border-radius: 3px;
border-radius: 3px;
margin: 0 .6em .4em .4em;
}
}
}
}
.admin-color-fresh {
.cmb2-element.ui-datepicker, .cmb2-element .ui-datepicker {
.ui-widget-header,
.ui-datepicker-header {
background: $freshblue;
}
thead {
background: $freshdark;
}
td .ui-state-hover {
background: $freshdarkblue;
color: #fff;
}
}
}
.admin-color-blue {
.cmb2-element.ui-datepicker, .cmb2-element .ui-datepicker {
.ui-widget-header,
.ui-datepicker-header {
background: #52accc;
}
thead {
background: #4796b3;
}
// td .ui-state-hover {
// background: #096484;
// }
td {
.ui-state-hover, .ui-state-active {
background: #096484;
color: #fff;
}
&.ui-datepicker-today {
background: #eee;
}
}
}
}
.admin-color-coffee {
.cmb2-element.ui-datepicker, .cmb2-element .ui-datepicker {
.ui-widget-header,
.ui-datepicker-header {
background: #59524c;
}
thead {
background: #46403c;
}
td .ui-state-hover {
background: #c7a589;
color: #fff;
}
}
}
.admin-color-ectoplasm {
.cmb2-element.ui-datepicker, .cmb2-element .ui-datepicker {
.ui-widget-header,
.ui-datepicker-header {
background: #523f6d;
}
thead {
background: #413256;
}
td .ui-state-hover {
background: #a3b745;
color: #fff;
}
}
}
.admin-color-midnight {
.cmb2-element.ui-datepicker, .cmb2-element .ui-datepicker {
.ui-widget-header,
.ui-datepicker-header {
background: #363b3f;
}
thead {
background: #26292c;
}
td .ui-state-hover {
background: #e14d43;
color: #fff;
}
}
}
.admin-color-ocean {
.cmb2-element.ui-datepicker, .cmb2-element .ui-datepicker {
.ui-widget-header,
.ui-datepicker-header {
background: #738e96;
}
thead {
background: #627c83;
}
td .ui-state-hover {
background: #9ebaa0;
color: #fff;
}
}
}
.admin-color-sunrise {
.cmb2-element.ui-datepicker, .cmb2-element .ui-datepicker {
.ui-widget-header,
.ui-datepicker-header,
.ui-datepicker-header .ui-state-hover {
background: #cf4944;
}
th {
border-color: #be3631;
background: #be3631;
}
td .ui-state-hover {
background: #dd823b;
color: #fff;
}
}
}
.admin-color-light {
.cmb2-element.ui-datepicker, .cmb2-element .ui-datepicker {
.ui-widget-header,
.ui-datepicker-header {
background: #e5e5e5;
}
select.ui-datepicker-month,
select.ui-datepicker-year {
color: #555;
}
thead {
background: #888;
}
.ui-datepicker-title,
td .ui-state-default,
.ui-datepicker-prev:before,
.ui-datepicker-next:before {
color: #555;
}
td {
.ui-state-hover, .ui-state-active {
background: #ccc;
}
&.ui-datepicker-today {
background: #eee;
}
}
}
}
.admin-color-bbp-evergreen {
.cmb2-element.ui-datepicker, .cmb2-element .ui-datepicker {
.ui-widget-header,
.ui-datepicker-header {
background: #56b274;
}
thead {
background: #36533f;
}
td .ui-state-hover {
background: #446950;
color: #fff;
}
}
}
.admin-color-bbp-mint {
.cmb2-element.ui-datepicker, .cmb2-element .ui-datepicker {
.ui-widget-header,
.ui-datepicker-header {
background: #4ca26a;
}
thead {
background: #4f6d59;
}
td .ui-state-hover {
background: #5fb37c;
color: #fff;
}
}
}

View File

@ -0,0 +1,534 @@
/*--------------------------------------------------------------
* Main Wrap
--------------------------------------------------------------*/
.cmb2-wrap {
margin: 0;
input,
textarea {
max-width: 100%;
}
input[type="text"] {
&.cmb2-oembed {
width: 100%;
}
}
textarea {
width: 500px;
padding: 8px;
&.cmb2-textarea-code {
font-family: $font-mono;
line-height: 16px;
}
}
input {
&.cmb2-text-small,
&.cmb2-timepicker {
width: 100px;
// margin-right: 15px
}
&.cmb2-text-money {
width: 90px;
// margin-right: 15px
}
&.cmb2-text-medium {
width: 230px;
// margin-right: 15px
}
&.cmb2-upload-file {
width: 65%;
}
&.ed_button {
padding: 2px 4px;
}
&:not([type="hidden"]) {
+ input,
+ .button-secondary,
+ select {
margin-left: 20px;
}
}
}
ul {
margin: 0;
}
li {
font-size: $font-size;
line-height: 16px;
margin: 1px 0 5px 0;
}
// .cmb-field-list .cmb-field-list {
// padding-top:5px;
// margin: 0;
// }
select {
font-size: $font-size;
margin-top: 3px;
}
input:focus,
textarea:focus {
background: $light-yellow;
}
input[type="radio"] {
margin: 0 5px 0 0;
padding: 0;
}
input[type="checkbox"] {
margin: 0 5px 0 0;
padding: 0;
}
button,
.button-secondary {
white-space: nowrap;
}
.mceLayout {
border: 1px solid $light-gray !important;
}
.mceIframeContainer {
background: $white;
}
.meta_mce {
width: 97%;
textarea {
width: 100%;
}
}
// Multicheck toggle
.cmb-multicheck-toggle {
margin-top: -1em;
}
// Color picker
.wp-picker-clear.button,
.wp-picker-default.button {
margin-left: 6px;
padding: 2px 8px;
}
.cmb-row {
margin: 0;
&:after {
content: '';
clear: both;
display: block;
width: 100%;
}
&.cmb-repeat .cmb2-metabox-description {
padding-top: 0;
padding-bottom: 1em;
}
}
}
// Fixes bug created by 5.3+ block editor-specific styling
// Over-specific selector to override WordPress's over-specific selector without !important
// @todo - Remove when `body.branch-5-3` targeting 5.3+ is widely used
body.block-editor-page.branch-5-3 .cmb2-wrap .cmb-row .cmb2-radio-list input[type="radio"]::before {
margin: .1875rem;
@media screen and (max-width: 782px) {
margin: .4375rem;
}
}
.cmb2-metabox {
clear: both;
margin: 0;
> .cmb-row:first-of-type >,
.cmb-field-list > .cmb-row:first-of-type > {
.cmb-td,
.cmb-th {
border: 0;
}
}
}
.cmb-add-row {
margin: 1.8em 0 0;
}
.cmb-nested .cmb-td,
.cmb-repeatable-group .cmb-th,
.cmb-repeatable-group:first-of-type {
border: 0;
}
.cmb-row:last-of-type,
.cmb2-wrap .cmb-row:last-of-type,
.cmb-repeatable-group:last-of-type {
border-bottom: 0;
}
.cmb-repeatable-grouping {
border: 1px solid $light-gray;
padding: 0 1em;
&.cmb-row {
margin: 0 0 0.8em;
}
+ .cmb-repeatable-grouping {
}
}
.cmb-th {
color: $dark-gray;
float: left;
font-weight: 600;
padding: 20px 10px 20px 0;
vertical-align: top;
width: 200px;
@media (max-width: $mobile-break) {
@include fullth;
}
}
.cmb-td {
line-height: 1.3;
max-width: 100%;
padding: 15px 10px;
vertical-align: middle;
}
.cmb-type-title {
.cmb-td {
padding: 0;
}
}
.cmb-th label {
display: block;
padding: 5px 0;
}
.cmb-th + .cmb-td {
float: left;
}
.cmb-td .cmb-td {
padding-bottom: 1em;
}
.cmb-remove-row {
text-align: right;
}
.empty-row.hidden {
display: none;
}
// Repeatable fields styles
.cmb-repeat-table {
background-color: $almostwhite;
border: 1px solid darken($light-gray, 3%);
.cmb-row.cmb-repeat-row {
position: relative;
counter-increment: el;
margin: 0;
padding: 10px 10px 10px 50px;
border-bottom: none !important; // Sometime, we need !important :).
& + .cmb-repeat-row {
border-top: solid 1px $light-gray;
}
&.ui-sortable-helper {
outline: dashed 2px $light-gray !important; // Sometime, we need !important :).
}
&:before {
content: counter(el);
display: block;
top: 0;
left: 0;
position: absolute;
width: 35px;
height: 100%;
line-height: 35px;
cursor: move;
color: $gray;
text-align: center;
border-right: solid 1px $light-gray;
}
.cmb-td {
margin: 0;
padding: 0;
}
}
+ .cmb-add-row {
margin: 0;
&:before {
content: '';
width: 1px;
height: 1.6em;
display: block;
margin-left: 17px;
background-color: darken($light-gray, 5%);
}
}
.cmb-remove-row {
top: 7px;
right: 7px;
position: absolute;
width: auto;
margin-left: 0;
padding: 0 !important; // Sometime, we need !important :).
display: none;
> .cmb-remove-row-button {
font-size: 20px;
text-indent: -1000px;
overflow: hidden;
position: relative;
height: auto;
line-height: 1;
padding: 0 10px 0;
&:before {
@include pseudo-dashicons("\f335");
line-height: 1.3;
}
}
}
.cmb-repeat-row:hover .cmb-remove-row {
display: block;
}
}
.cmb-repeatable-group {
.cmb-th {
padding: 5px;
}
.cmb-group-title {
background-color: $light-gray;
padding: 8px 12px 8px 2.2em;
margin: 0 -1em;
min-height: 1.5em;
font-size: 14px;
line-height: 1.4;
h4 {
border: 0;
margin: 0;
font-size: 1.2em;
font-weight: 500;
padding: 0.5em 0.75em;
}
.cmb-th {
display: block;
width: 100%;
}
}
.cmb-group-description .cmb-th {
@include fullth;
}
.cmb-shift-rows {
margin-right: 1em;
.dashicons-arrow-up-alt2 {
margin-top: .15em;
}
.dashicons-arrow-down-alt2 {
margin-top: .2em;
}
}
.cmb2-upload-button {
float: right;
}
}
p.cmb2-metabox-description {
color: $medium-gray;
letter-spacing: 0.01em;
margin: 0;
padding-top: .5em;
}
span.cmb2-metabox-description {
color: $medium-gray;
letter-spacing: 0.01em;
}
.cmb2-metabox-title {
margin: 0 0 5px 0;
padding: 5px 0 0 0;
font-size: 14px;
}
.cmb-inline ul {
padding: 4px 0 0 0;
}
.cmb-inline li {
display: inline-block;
padding-right: 18px;
}
.cmb-type-textarea-code pre {
margin: 0;
}
.cmb2-media-status {
.img-status {
clear: none;
display: inline-block;
vertical-align: middle;
margin-right: 10px;
width: auto;
img {
max-width: 350px;
height: auto;
}
}
.img-status img,
.embed-status {
background: $lightchecker;
border: 5px solid $white;
outline: 1px solid $light-gray;
box-shadow: inset 0 0 15px rgba( 0, 0, 0, 0.3 ), inset 0 0 0 1px rgba( 0, 0, 0, 0.05 );
background-image: linear-gradient(45deg, $darkchecker 25%, transparent 25%, transparent 75%, $darkchecker 75%, $darkchecker), linear-gradient(45deg, $darkchecker 25%, transparent 25%, transparent 75%, $darkchecker 75%, $darkchecker);
background-position: 0 0, 10px 10px;
background-size: 20px 20px;
border-radius: 2px;
-moz-border-radius: 2px;
margin: 15px 0 0 0;
}
.embed-status {
float: left;
max-width: 800px;
}
.img-status, .embed-status {
position: relative;
.cmb2-remove-file-button {
background: url(../images/ico-delete.png);
height: 16px;
left: -5px;
position: absolute;
text-indent: -9999px;
top: -5px;
width: 16px;
}
}
.img-status {
.cmb2-remove-file-button {
top: 10px;
}
}
.img-status img, .file-status > span {
cursor: pointer;
}
&.cmb-attach-list {
.img-status img, .file-status > span {
cursor: move;
}
}
}
.cmb-type-file-list .cmb2-media-status .img-status {
clear: none;
vertical-align: middle;
width: auto;
margin-right: 10px;
margin-bottom: 10px;
margin-top: 0;
}
.cmb-attach-list li {
clear: both;
display: inline-block;
width: 100%;
margin-top: 5px;
margin-bottom: 10px;
img {
float: left;
margin-right: 10px;
}
}
.cmb2-remove-wrapper {
margin: 0;
}
.child-cmb2 .cmb-th {
text-align: left;
}
.cmb2-indented-hierarchy {
padding-left: 1.5em;
}
@media (max-width: $mobile-break) {
.cmb-th,
.cmb-td,
.cmb-th + .cmb-td {
display: block;
float: none;
width: 100%;
}
}

View File

@ -0,0 +1,29 @@
/*--------------------------------------------------------------
* Misc.
--------------------------------------------------------------*/
#poststuff .cmb-repeatable-group h2 {
margin: 0;
}
.edit-tags-php,
.profile-php,
.user-edit-php {
.cmb2-metabox-title {
font-size: 1.4em;
}
}
.cmb2-postbox, .cmb2-no-box-wrap {
.cmb-spinner {
float: left;
display: none;
}
}
.cmb-spinner {
display: none;
&.is-active {
display: block;
}
}

View File

@ -0,0 +1,51 @@
//--------------------------------------------------------------
// Mixins
//--------------------------------------------------------------
@mixin fullth() {
font-size: 1.2em;
@include _fullth;
}
@mixin fullth_side() {
@include _fullth;
label {
font-size: $font-size;
line-height: 1.4em;
}
}
@mixin _fullth() {
display: block;
float: none;
padding-bottom: 1em;
text-align: left;
width: 100%;
label {
display: block;
margin-top: 0;
margin-bottom: 0.5em;
}
}
@mixin pseudo-dashicons( $glyph: "\f333" ) {
content: $glyph;
font-family: 'Dashicons';
speak: none;
font-weight: normal;
font-variant: normal;
text-transform: none;
line-height: 1;
-webkit-font-smoothing: antialiased;
margin: 0;
text-indent: 0;
position: absolute;
top: 0;
left: 0;
width: 100%;
height: 100%;
text-align: center;
}

View File

@ -0,0 +1,31 @@
/*--------------------------------------------------------------
* New-Term Page
--------------------------------------------------------------*/
#addtag {
.cmb-th {
float: none;
width: auto;
padding: 20px 0 0;
}
.cmb-td {
padding: 0;
}
.cmb-th + .cmb-td {
float: none;
}
select {
max-width: 100%;
}
.cmb2-metabox {
padding-bottom: 20px;
}
.cmb-row li label {
display: inline;
}
}

View File

@ -0,0 +1,71 @@
/*--------------------------------------------------------------
* Options page
--------------------------------------------------------------*/
.cmb2-options-page {
max-width: 1200px;
&.wrap > h2 {
margin-bottom: 1em;
}
.cmb2-metabox > .cmb-row {
padding: 1em;
margin-top: -1px;
background: $white;
border: 1px solid $light-gray;
box-shadow: 0 1px 1px rgba(black, 0.05);
> .cmb-th {
padding: 0;
font-weight: initial;
}
> .cmb-th + .cmb-td {
float: none;
padding: 0 0 0 1em;
margin-left: 200px;
@media (max-width: $mobile-break) {
padding: 0;
margin-left: 0;
}
}
}
// Title field style.
.cmb2-wrap .cmb-type-title {
margin-top: 1em;
padding: 0.6em 1em;
background-color: $almostwhite;
.cmb2-metabox-title {
font-size: 12px;
margin-top: 0;
margin-bottom: 0;
text-transform: uppercase;
}
.cmb2-metabox-description {
padding-top: 0.25em;
}
}
.cmb-repeatable-group {
.cmb-group-description .cmb-th {
padding: 0 0 0.8em 0;
}
.cmb-group-name {
font-size: 16px;
margin-top: 0;
margin-bottom: 0;
}
.cmb-th > .cmb2-metabox-description {
font-weight: 400;
padding-bottom: 0 !important;
}
}
}

View File

@ -0,0 +1,99 @@
/*--------------------------------------------------------------
* Post Metaboxes
--------------------------------------------------------------*/
#poststuff .cmb-group-title {
margin-left: -1em;
margin-right: -1em;
min-height: 1.5em;
}
#poststuff .repeatable .cmb-group-title {
padding-left: 2.2em;
}
.cmb2-postbox, .cmb-type-group {
.cmb2-wrap {
margin: 0;
> .cmb-field-list > .cmb-row {
padding: 1.8em 0;
}
input[type=text] {
&.cmb2-oembed {
width: 100%;
}
}
}
.cmb-row {
padding: 0 0 1.8em;
margin: 0 0 0.8em;
.cmbhandle {
right: -1em;
position: relative;
color: $dark-gray;
}
}
.cmb-repeatable-grouping {
padding: 0 1em;
max-width: 100%;
min-width: 1px !important;
}
.cmb-repeatable-group > .cmb-row {
padding-bottom: 0;
}
.cmb-th {
width: 18%;
padding: 0 2% 0 0;
// text-align: right;
}
.cmb-td {
margin-bottom: 0;
padding: 0;
line-height: 1.3;
}
.cmb-th + .cmb-td {
width: 80%;
float: right;
}
.cmb-row:not(:last-of-type),
.cmb-repeatable-group:not(:last-of-type) {
border-bottom: 1px solid $light-gray;
@media (max-width: $mobile-break) {
border-bottom: 0;
}
}
.cmb-repeat-group-field,
.cmb-remove-field-row {
padding-top: 1.8em;
}
.button-secondary {
.dashicons {
line-height: 1.3;
}
&.move-up, &.move-down {
.dashicons {
line-height: 1.1;
}
}
&.cmb-add-group-row {
.dashicons {
line-height: 1.5;
}
}
}
}

View File

@ -0,0 +1,146 @@
/*--------------------------------------------------------------
* Sidebar Placement Adjustments
--------------------------------------------------------------*/
.inner-sidebar,
#side-sortables {
.cmb2-wrap {
> .cmb-field-list > .cmb-row {
padding: 1.4em 0;
}
input {
&[type=text]:not( .wp-color-picker ) {
width: 100%;
}
+ input:not( .wp-picker-clear ), + select {
margin-left: 0;
margin-top: 1em;
display: block;
}
&.cmb2-text-money {
max-width: 70%;
+ .cmb2-metabox-description {
display: block;
}
}
}
label {
display: block;
font-weight: 700;
padding: 0 0 5px;
}
}
textarea {
max-width: 99%;
}
.cmb-repeatable-group {
border-bottom: 1px solid $light-gray;
}
.cmb-type-group > .cmb-td > .cmb-repeatable-group {
border-bottom: 0;
margin-bottom: -1.4em;
}
.cmb-th,
.cmb-td:not(.cmb-remove-row),
.cmb-th + .cmb-td {
width: 100%;
display: block;
float: none;
}
.closed .inside {
display: none;
}
.cmb-th {
@include fullth_side;
padding-left: 0;
padding-right: 0;
}
.cmb-group-description {
.cmb-th {
padding-top: 0;
}
.cmb2-metabox-description {
padding: 0;
}
}
.cmb-group-title {
// padding-bottom: 0;
.cmb-th {
padding: 0;
}
}
.cmb-repeatable-grouping {
+ .cmb-repeatable-grouping {
margin-top: 1em;
}
}
.cmb2-media-status {
.img-status,
.embed-status {
img {
max-width: 90%;
// width: auto;
height: auto;
}
}
}
.cmb2-list label {
display: inline;
font-weight: normal;
}
.cmb2-metabox-description {
display: block;
padding: 7px 0 0;
}
.cmb-type-checkbox {
.cmb-td label,
.cmb2-metabox-description {
font-weight: normal;
display: inline;
}
}
.cmb-row .cmb2-metabox-description {
padding-bottom: 1.8em;
}
.cmb2-metabox-title {
font-size: 1.2em;
font-style: italic;
}
.cmb-remove-row {
clear: both;
padding-top: 12px;
padding-bottom: 0;
}
.cmb2-upload-button {
clear: both;
margin-top: 12px;
}
}

View File

@ -0,0 +1,26 @@
//--------------------------------------------------------------
// Variables
//--------------------------------------------------------------
// Mobile break-point
$mobile-break : 450px;
// Fonts
$font-sans : sans-serif;
$font-serif : Georgia, Times, "Times New Roman", serif;
$font-mono : "Courier 10 Pitch", Courier, monospace;
$font-size : 14px;
// Colors
$dark-gray : #222222;
$gray : #757575;
$medium-gray : #666;
$light-gray : #e9e9e9;
$lightchecker : #eee;
$darkchecker : #d0d0d0;
$blue : #0063ce;
$light-yellow : #fffff8;
$white : #ffffff;
$almostwhite : #fafafa;
$red : #f00;
$dark-red : #a00;

View File

@ -0,0 +1,2 @@
<?php
// Silence is golden

View File

@ -0,0 +1,807 @@
<?php
/**
* Include and setup custom metaboxes and fields. (make sure you copy this file to outside the CMB2 directory)
*
* Be sure to replace all instances of 'yourprefix_' with your project's prefix.
* http://nacin.com/2010/05/11/in-wordpress-prefix-everything/
*
* @category YourThemeOrPlugin
* @package Demo_CMB2
* @license http://www.opensource.org/licenses/gpl-license.php GPL v2.0 (or later)
* @link https://github.com/CMB2/CMB2
*/
/**
* Get the bootstrap! If using the plugin from wordpress.org, REMOVE THIS!
*/
if ( file_exists( dirname( __FILE__ ) . '/cmb2/init.php' ) ) {
require_once dirname( __FILE__ ) . '/cmb2/init.php';
} elseif ( file_exists( dirname( __FILE__ ) . '/CMB2/init.php' ) ) {
require_once dirname( __FILE__ ) . '/CMB2/init.php';
}
/**
* Conditionally displays a metabox when used as a callback in the 'show_on_cb' cmb2_box parameter
*
* @param CMB2 $cmb CMB2 object.
*
* @return bool True if metabox should show
*/
function yourprefix_show_if_front_page( $cmb ) {
// Don't show this metabox if it's not the front page template.
if ( get_option( 'page_on_front' ) !== $cmb->object_id ) {
return false;
}
return true;
}
/**
* Conditionally displays a field when used as a callback in the 'show_on_cb' field parameter
*
* @param CMB2_Field $field Field object.
*
* @return bool True if metabox should show
*/
function yourprefix_hide_if_no_cats( $field ) {
// Don't show this field if not in the cats category.
if ( ! has_tag( 'cats', $field->object_id ) ) {
return false;
}
return true;
}
/**
* Manually render a field.
*
* @param array $field_args Array of field arguments.
* @param CMB2_Field $field The field object.
*/
function yourprefix_render_row_cb( $field_args, $field ) {
$classes = $field->row_classes();
$id = $field->args( 'id' );
$label = $field->args( 'name' );
$name = $field->args( '_name' );
$value = $field->escaped_value();
$description = $field->args( 'description' );
?>
<div class="custom-field-row <?php echo esc_attr( $classes ); ?>">
<p><label for="<?php echo esc_attr( $id ); ?>"><?php echo esc_html( $label ); ?></label></p>
<p><input id="<?php echo esc_attr( $id ); ?>" type="text" name="<?php echo esc_attr( $name ); ?>" value="<?php echo $value; ?>"/></p>
<p class="description"><?php echo esc_html( $description ); ?></p>
</div>
<?php
}
/**
* Manually render a field column display.
*
* @param array $field_args Array of field arguments.
* @param CMB2_Field $field The field object.
*/
function yourprefix_display_text_small_column( $field_args, $field ) {
?>
<div class="custom-column-display <?php echo esc_attr( $field->row_classes() ); ?>">
<p><?php echo $field->escaped_value(); ?></p>
<p class="description"><?php echo esc_html( $field->args( 'description' ) ); ?></p>
</div>
<?php
}
/**
* Conditionally displays a message if the $post_id is 2
*
* @param array $field_args Array of field parameters.
* @param CMB2_Field $field Field object.
*/
function yourprefix_before_row_if_2( $field_args, $field ) {
if ( 2 == $field->object_id ) {
echo '<p>Testing <b>"before_row"</b> parameter (on $post_id 2)</p>';
} else {
echo '<p>Testing <b>"before_row"</b> parameter (<b>NOT</b> on $post_id 2)</p>';
}
}
add_action( 'cmb2_admin_init', 'yourprefix_register_demo_metabox' );
/**
* Hook in and add a demo metabox. Can only happen on the 'cmb2_admin_init' or 'cmb2_init' hook.
*/
function yourprefix_register_demo_metabox() {
/**
* Sample metabox to demonstrate each field type included
*/
$cmb_demo = new_cmb2_box( array(
'id' => 'yourprefix_demo_metabox',
'title' => esc_html__( 'Test Metabox', 'cmb2' ),
'object_types' => array( 'page' ), // Post type
// 'show_on_cb' => 'yourprefix_show_if_front_page', // function should return a bool value
// 'context' => 'normal',
// 'priority' => 'high',
// 'show_names' => true, // Show field names on the left
// 'cmb_styles' => false, // false to disable the CMB stylesheet
// 'closed' => true, // true to keep the metabox closed by default
// 'classes' => 'extra-class', // Extra cmb2-wrap classes
// 'classes_cb' => 'yourprefix_add_some_classes', // Add classes through a callback.
/*
* The following parameter is any additional arguments passed as $callback_args
* to add_meta_box, if/when applicable.
*
* CMB2 does not use these arguments in the add_meta_box callback, however, these args
* are parsed for certain special properties, like determining Gutenberg/block-editor
* compatibility.
*
* Examples:
*
* - Make sure default editor is used as metabox is not compatible with block editor
* [ '__block_editor_compatible_meta_box' => false/true ]
*
* - Or declare this box exists for backwards compatibility
* [ '__back_compat_meta_box' => false ]
*
* More: https://wordpress.org/gutenberg/handbook/extensibility/meta-box/
*/
// 'mb_callback_args' => array( '__block_editor_compatible_meta_box' => false ),
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Text', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_text',
'type' => 'text',
'show_on_cb' => 'yourprefix_hide_if_no_cats', // function should return a bool value
// 'sanitization_cb' => 'my_custom_sanitization', // custom sanitization callback parameter
// 'escape_cb' => 'my_custom_escaping', // custom escaping callback parameter
// 'on_front' => false, // Optionally designate a field to wp-admin only
// 'repeatable' => true,
// 'column' => true, // Display field value in the admin post-listing columns
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Text Small', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_textsmall',
'type' => 'text_small',
// 'repeatable' => true,
// 'column' => array(
// 'name' => esc_html__( 'Column Title', 'cmb2' ), // Set the admin column title
// 'position' => 2, // Set as the second column.
// );
// 'display_cb' => 'yourprefix_display_text_small_column', // Output the display of the column values through a callback.
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Text Medium', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_textmedium',
'type' => 'text_medium',
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Read-only Disabled Field', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_readonly',
'type' => 'text_medium',
'default' => esc_attr__( 'Hey there, I\'m a read-only field', 'cmb2' ),
'save_field' => false, // Disables the saving of this field.
'attributes' => array(
'disabled' => 'disabled',
'readonly' => 'readonly',
),
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Custom Rendered Field', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_render_row_cb',
'type' => 'text',
'render_row_cb' => 'yourprefix_render_row_cb',
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Website URL', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_url',
'type' => 'text_url',
// 'protocols' => array('http', 'https', 'ftp', 'ftps', 'mailto', 'news', 'irc', 'gopher', 'nntp', 'feed', 'telnet'), // Array of allowed protocols
// 'repeatable' => true,
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Text Email', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_email',
'type' => 'text_email',
// 'repeatable' => true,
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Time', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_time',
'type' => 'text_time',
// 'time_format' => 'H:i', // Set to 24hr format
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Time zone', 'cmb2' ),
'desc' => esc_html__( 'Time zone', 'cmb2' ),
'id' => 'yourprefix_demo_timezone',
'type' => 'select_timezone',
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Date Picker', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_textdate',
'type' => 'text_date',
// 'date_format' => 'Y-m-d',
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Date Picker (UNIX timestamp)', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_textdate_timestamp',
'type' => 'text_date_timestamp',
// 'timezone_meta_key' => 'yourprefix_demo_timezone', // Optionally make this field honor the timezone selected in the select_timezone specified above
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Date/Time Picker Combo (UNIX timestamp)', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_datetime_timestamp',
'type' => 'text_datetime_timestamp',
) );
// This text_datetime_timestamp_timezone field type
// is only compatible with PHP versions 5.3 or above.
// Feel free to uncomment and use if your server meets the requirement
// $cmb_demo->add_field( array(
// 'name' => esc_html__( 'Test Date/Time Picker/Time zone Combo (serialized DateTime object)', 'cmb2' ),
// 'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
// 'id' => 'yourprefix_demo_datetime_timestamp_timezone',
// 'type' => 'text_datetime_timestamp_timezone',
// ) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Money', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_textmoney',
'type' => 'text_money',
// 'before_field' => '£', // override '$' symbol if needed
// 'repeatable' => true,
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Color Picker', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_colorpicker',
'type' => 'colorpicker',
'default' => '#ffffff',
// 'options' => array(
// 'alpha' => true, // Make this a rgba color picker.
// ),
// 'attributes' => array(
// 'data-colorpicker' => json_encode( array(
// 'palettes' => array( '#3dd0cc', '#ff834c', '#4fa2c0', '#0bc991', ),
// ) ),
// ),
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Text Area', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_textarea',
'type' => 'textarea',
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Text Area Small', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_textareasmall',
'type' => 'textarea_small',
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Text Area for Code', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_textarea_code',
'type' => 'textarea_code',
// 'attributes' => array(
// // Optionally override the code editor defaults.
// 'data-codeeditor' => json_encode( array(
// 'codemirror' => array(
// 'lineNumbers' => false,
// 'mode' => 'css',
// ),
// ) ),
// ),
// To keep the previous formatting, you can disable codemirror.
// 'options' => array( 'disable_codemirror' => true ),
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Title Weeeee', 'cmb2' ),
'desc' => esc_html__( 'This is a title description', 'cmb2' ),
'id' => 'yourprefix_demo_title',
'type' => 'title',
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Select', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_select',
'type' => 'select',
'show_option_none' => true,
'options' => array(
'standard' => esc_html__( 'Option One', 'cmb2' ),
'custom' => esc_html__( 'Option Two', 'cmb2' ),
'none' => esc_html__( 'Option Three', 'cmb2' ),
),
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Radio inline', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_radio_inline',
'type' => 'radio_inline',
'show_option_none' => 'No Selection',
'options' => array(
'standard' => esc_html__( 'Option One', 'cmb2' ),
'custom' => esc_html__( 'Option Two', 'cmb2' ),
'none' => esc_html__( 'Option Three', 'cmb2' ),
),
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Radio', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_radio',
'type' => 'radio',
'options' => array(
'option1' => esc_html__( 'Option One', 'cmb2' ),
'option2' => esc_html__( 'Option Two', 'cmb2' ),
'option3' => esc_html__( 'Option Three', 'cmb2' ),
),
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Taxonomy Radio', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_text_taxonomy_radio',
'type' => 'taxonomy_radio', // Or `taxonomy_radio_inline`/`taxonomy_radio_hierarchical`
'taxonomy' => 'category', // Taxonomy Slug
// 'inline' => true, // Toggles display to inline
// Optionally override the args sent to the WordPress get_terms function.
'query_args' => array(
// 'orderby' => 'slug',
// 'hide_empty' => true,
),
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Taxonomy Select', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_taxonomy_select',
'type' => 'taxonomy_select', // Or `taxonomy_select_hierarchical`
'taxonomy' => 'category', // Taxonomy Slug
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Taxonomy Multi Checkbox', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_multitaxonomy',
'type' => 'taxonomy_multicheck', // Or `taxonomy_multicheck_inline`/`taxonomy_multicheck_hierarchical`
'taxonomy' => 'post_tag', // Taxonomy Slug
// 'inline' => true, // Toggles display to inline
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Checkbox', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_checkbox',
'type' => 'checkbox',
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Multi Checkbox', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_multicheckbox',
'type' => 'multicheck',
// 'multiple' => true, // Store values in individual rows
'options' => array(
'check1' => esc_html__( 'Check One', 'cmb2' ),
'check2' => esc_html__( 'Check Two', 'cmb2' ),
'check3' => esc_html__( 'Check Three', 'cmb2' ),
),
// 'inline' => true, // Toggles display to inline
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test wysiwyg', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_demo_wysiwyg',
'type' => 'wysiwyg',
'options' => array(
'textarea_rows' => 5,
),
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Test Image', 'cmb2' ),
'desc' => esc_html__( 'Upload an image or enter a URL.', 'cmb2' ),
'id' => 'yourprefix_demo_image',
'type' => 'file',
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'Multiple Files', 'cmb2' ),
'desc' => esc_html__( 'Upload or add multiple images/attachments.', 'cmb2' ),
'id' => 'yourprefix_demo_file_list',
'type' => 'file_list',
'preview_size' => array( 100, 100 ), // Default: array( 50, 50 )
) );
$cmb_demo->add_field( array(
'name' => esc_html__( 'oEmbed', 'cmb2' ),
'desc' => sprintf(
/* translators: %s: link to codex.wordpress.org/Embeds */
esc_html__( 'Enter a youtube, twitter, or instagram URL. Supports services listed at %s.', 'cmb2' ),
'<a href="https://wordpress.org/support/article/embeds/">codex.wordpress.org/Embeds</a>'
),
'id' => 'yourprefix_demo_embed',
'type' => 'oembed',
) );
$cmb_demo->add_field( array(
'name' => 'Testing Field Parameters',
'id' => 'yourprefix_demo_parameters',
'type' => 'text',
'before_row' => 'yourprefix_before_row_if_2', // callback.
'before' => '<p>Testing <b>"before"</b> parameter</p>',
'before_field' => '<p>Testing <b>"before_field"</b> parameter</p>',
'after_field' => '<p>Testing <b>"after_field"</b> parameter</p>',
'after' => '<p>Testing <b>"after"</b> parameter</p>',
'after_row' => '<p>Testing <b>"after_row"</b> parameter</p>',
) );
}
add_action( 'cmb2_admin_init', 'yourprefix_register_about_page_metabox' );
/**
* Hook in and add a metabox that only appears on the 'About' page
*/
function yourprefix_register_about_page_metabox() {
/**
* Metabox to be displayed on a single page ID
*/
$cmb_about_page = new_cmb2_box( array(
'id' => 'yourprefix_about_metabox',
'title' => esc_html__( 'About Page Metabox', 'cmb2' ),
'object_types' => array( 'page' ), // Post type
'context' => 'normal',
'priority' => 'high',
'show_names' => true, // Show field names on the left
'show_on' => array(
'id' => array( 2 ),
), // Specific post IDs to display this metabox
) );
$cmb_about_page->add_field( array(
'name' => esc_html__( 'Test Text', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_about_text',
'type' => 'text',
) );
}
add_action( 'cmb2_admin_init', 'yourprefix_register_repeatable_group_field_metabox' );
/**
* Hook in and add a metabox to demonstrate repeatable grouped fields
*/
function yourprefix_register_repeatable_group_field_metabox() {
/**
* Repeatable Field Groups
*/
$cmb_group = new_cmb2_box( array(
'id' => 'yourprefix_group_metabox',
'title' => esc_html__( 'Repeating Field Group', 'cmb2' ),
'object_types' => array( 'page' ),
) );
// $group_field_id is the field id string, so in this case: 'yourprefix_group_demo'
$group_field_id = $cmb_group->add_field( array(
'id' => 'yourprefix_group_demo',
'type' => 'group',
'description' => esc_html__( 'Generates reusable form entries', 'cmb2' ),
'options' => array(
'group_title' => esc_html__( 'Entry {#}', 'cmb2' ), // {#} gets replaced by row number
'add_button' => esc_html__( 'Add Another Entry', 'cmb2' ),
'remove_button' => esc_html__( 'Remove Entry', 'cmb2' ),
'sortable' => true,
// 'closed' => true, // true to have the groups closed by default
// 'remove_confirm' => esc_html__( 'Are you sure you want to remove?', 'cmb2' ), // Performs confirmation before removing group.
),
) );
/**
* Group fields works the same, except ids only need
* to be unique to the group. Prefix is not needed.
*
* The parent field's id needs to be passed as the first argument.
*/
$cmb_group->add_group_field( $group_field_id, array(
'name' => esc_html__( 'Entry Title', 'cmb2' ),
'id' => 'title',
'type' => 'text',
// 'repeatable' => true, // Repeatable fields are supported w/in repeatable groups (for most types)
) );
$cmb_group->add_group_field( $group_field_id, array(
'name' => esc_html__( 'Description', 'cmb2' ),
'description' => esc_html__( 'Write a short description for this entry', 'cmb2' ),
'id' => 'description',
'type' => 'textarea_small',
) );
$cmb_group->add_group_field( $group_field_id, array(
'name' => esc_html__( 'Entry Image', 'cmb2' ),
'id' => 'image',
'type' => 'file',
) );
$cmb_group->add_group_field( $group_field_id, array(
'name' => esc_html__( 'Image Caption', 'cmb2' ),
'id' => 'image_caption',
'type' => 'text',
) );
}
add_action( 'cmb2_admin_init', 'yourprefix_register_user_profile_metabox' );
/**
* Hook in and add a metabox to add fields to the user profile pages
*/
function yourprefix_register_user_profile_metabox() {
/**
* Metabox for the user profile screen
*/
$cmb_user = new_cmb2_box( array(
'id' => 'yourprefix_user_edit',
'title' => esc_html__( 'User Profile Metabox', 'cmb2' ), // Doesn't output for user boxes
'object_types' => array( 'user' ), // Tells CMB2 to use user_meta vs post_meta
'show_names' => true,
'new_user_section' => 'add-new-user', // where form will show on new user page. 'add-existing-user' is only other valid option.
) );
$cmb_user->add_field( array(
'name' => esc_html__( 'Extra Info', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_user_extra_info',
'type' => 'title',
'on_front' => false,
) );
$cmb_user->add_field( array(
'name' => esc_html__( 'Avatar', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_user_avatar',
'type' => 'file',
) );
$cmb_user->add_field( array(
'name' => esc_html__( 'Facebook URL', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_user_facebookurl',
'type' => 'text_url',
) );
$cmb_user->add_field( array(
'name' => esc_html__( 'Twitter URL', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_user_twitterurl',
'type' => 'text_url',
) );
$cmb_user->add_field( array(
'name' => esc_html__( 'Google+ URL', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_user_googleplusurl',
'type' => 'text_url',
) );
$cmb_user->add_field( array(
'name' => esc_html__( 'Linkedin URL', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_user_linkedinurl',
'type' => 'text_url',
) );
$cmb_user->add_field( array(
'name' => esc_html__( 'User Field', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_user_user_text_field',
'type' => 'text',
) );
}
add_action( 'cmb2_admin_init', 'yourprefix_register_taxonomy_metabox' );
/**
* Hook in and add a metabox to add fields to taxonomy terms
*/
function yourprefix_register_taxonomy_metabox() {
/**
* Metabox to add fields to categories and tags
*/
$cmb_term = new_cmb2_box( array(
'id' => 'yourprefix_term_edit',
'title' => esc_html__( 'Category Metabox', 'cmb2' ), // Doesn't output for term boxes
'object_types' => array( 'term' ), // Tells CMB2 to use term_meta vs post_meta
'taxonomies' => array( 'category', 'post_tag' ), // Tells CMB2 which taxonomies should have these fields
// 'new_term_section' => true, // Will display in the "Add New Category" section
) );
$cmb_term->add_field( array(
'name' => esc_html__( 'Extra Info', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_term_extra_info',
'type' => 'title',
'on_front' => false,
) );
$cmb_term->add_field( array(
'name' => esc_html__( 'Term Image', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_term_avatar',
'type' => 'file',
) );
$cmb_term->add_field( array(
'name' => esc_html__( 'Arbitrary Term Field', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'yourprefix_term_term_text_field',
'type' => 'text',
) );
}
add_action( 'cmb2_admin_init', 'yourprefix_register_theme_options_metabox' );
/**
* Hook in and register a metabox to handle a theme options page and adds a menu item.
*/
function yourprefix_register_theme_options_metabox() {
/**
* Registers options page menu item and form.
*/
$cmb_options = new_cmb2_box( array(
'id' => 'yourprefix_theme_options_page',
'title' => esc_html__( 'Theme Options', 'cmb2' ),
'object_types' => array( 'options-page' ),
/*
* The following parameters are specific to the options-page box
* Several of these parameters are passed along to add_menu_page()/add_submenu_page().
*/
'option_key' => 'yourprefix_theme_options', // The option key and admin menu page slug.
'icon_url' => 'dashicons-palmtree', // Menu icon. Only applicable if 'parent_slug' is left empty.
// 'menu_title' => esc_html__( 'Options', 'cmb2' ), // Falls back to 'title' (above).
// 'parent_slug' => 'themes.php', // Make options page a submenu item of the themes menu.
// 'capability' => 'manage_options', // Cap required to view options-page.
// 'position' => 1, // Menu position. Only applicable if 'parent_slug' is left empty.
// 'admin_menu_hook' => 'network_admin_menu', // 'network_admin_menu' to add network-level options page.
// 'priority' => 10, // Define the page-registration admin menu hook priority.
// 'display_cb' => false, // Override the options-page form output (CMB2_Hookup::options_page_output()).
// 'save_button' => esc_html__( 'Save Theme Options', 'cmb2' ), // The text for the options-page save button. Defaults to 'Save'.
// 'disable_settings_errors' => true, // On settings pages (not options-general.php sub-pages), allows disabling.
// 'message_cb' => 'yourprefix_options_page_message_callback',
// 'tab_group' => '', // Tab-group identifier, enables options page tab navigation.
// 'tab_title' => null, // Falls back to 'title' (above).
// 'autoload' => false, // Defaults to true, the options-page option will be autloaded.
) );
/**
* Options fields ids only need
* to be unique within this box.
* Prefix is not needed.
*/
$cmb_options->add_field( array(
'name' => esc_html__( 'Site Background Color', 'cmb2' ),
'desc' => esc_html__( 'field description (optional)', 'cmb2' ),
'id' => 'bg_color',
'type' => 'colorpicker',
'default' => '#ffffff',
) );
}
/**
* Callback to define the optionss-saved message.
*
* @param CMB2 $cmb The CMB2 object.
* @param array $args {
* An array of message arguments
*
* @type bool $is_options_page Whether current page is this options page.
* @type bool $should_notify Whether options were saved and we should be notified.
* @type bool $is_updated Whether options were updated with save (or stayed the same).
* @type string $setting For add_settings_error(), Slug title of the setting to which
* this error applies.
* @type string $code For add_settings_error(), Slug-name to identify the error.
* Used as part of 'id' attribute in HTML output.
* @type string $message For add_settings_error(), The formatted message text to display
* to the user (will be shown inside styled `<div>` and `<p>` tags).
* Will be 'Settings updated.' if $is_updated is true, else 'Nothing to update.'
* @type string $type For add_settings_error(), Message type, controls HTML class.
* Accepts 'error', 'updated', '', 'notice-warning', etc.
* Will be 'updated' if $is_updated is true, else 'notice-warning'.
* }
*/
function yourprefix_options_page_message_callback( $cmb, $args ) {
if ( ! empty( $args['should_notify'] ) ) {
if ( $args['is_updated'] ) {
// Modify the updated message.
$args['message'] = sprintf( esc_html__( '%s &mdash; Updated!', 'cmb2' ), $cmb->prop( 'title' ) );
}
add_settings_error( $args['setting'], $args['code'], $args['message'], $args['type'] );
}
}
/**
* Only show this box in the CMB2 REST API if the user is logged in.
*
* @param bool $is_allowed Whether this box and its fields are allowed to be viewed.
* @param CMB2_REST_Controller $cmb_controller The controller object.
* CMB2 object available via `$cmb_controller->rest_box->cmb`.
*
* @return bool Whether this box and its fields are allowed to be viewed.
*/
function yourprefix_limit_rest_view_to_logged_in_users( $is_allowed, $cmb_controller ) {
if ( ! is_user_logged_in() ) {
$is_allowed = false;
}
return $is_allowed;
}
add_action( 'cmb2_init', 'yourprefix_register_rest_api_box' );
/**
* Hook in and add a box to be available in the CMB2 REST API. Can only happen on the 'cmb2_init' hook.
* More info: https://github.com/CMB2/CMB2/wiki/REST-API
*/
function yourprefix_register_rest_api_box() {
$cmb_rest = new_cmb2_box( array(
'id' => 'yourprefix_rest_metabox',
'title' => esc_html__( 'REST Test Box', 'cmb2' ),
'object_types' => array( 'page' ), // Post type
'show_in_rest' => WP_REST_Server::ALLMETHODS, // WP_REST_Server::READABLE|WP_REST_Server::EDITABLE, // Determines which HTTP methods the box is visible in.
// Optional callback to limit box visibility.
// See: https://github.com/CMB2/CMB2/wiki/REST-API#permissions
// 'get_box_permissions_check_cb' => 'yourprefix_limit_rest_view_to_logged_in_users',
) );
$cmb_rest->add_field( array(
'name' => esc_html__( 'REST Test Text', 'cmb2' ),
'desc' => esc_html__( 'Will show in the REST API for this box and for pages.', 'cmb2' ),
'id' => 'yourprefix_rest_text',
'type' => 'text',
) );
$cmb_rest->add_field( array(
'name' => esc_html__( 'REST Editable Test Text', 'cmb2' ),
'desc' => esc_html__( 'Will show in REST API "editable" contexts only (`POST` requests).', 'cmb2' ),
'id' => 'yourprefix_rest_editable_text',
'type' => 'text',
'show_in_rest' => WP_REST_Server::EDITABLE,// WP_REST_Server::ALLMETHODS|WP_REST_Server::READABLE, // Determines which HTTP methods the field is visible in. Will override the cmb2_box 'show_in_rest' param.
) );
}

Binary file not shown.

After

Width:  |  Height:  |  Size: 715 B

View File

@ -0,0 +1,2 @@
<?php
// Silence is golden

Binary file not shown.

After

Width:  |  Height:  |  Size: 180 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 178 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 120 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 105 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 111 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 110 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 119 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 101 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 5.2 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 4.3 KiB

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,323 @@
<?php
/**
* CMB2 ajax methods
* (i.e. a lot of work to get oEmbeds to work with non-post objects)
*
* @since 0.9.5
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
*/
class CMB2_Ajax {
// Whether to hijack the oembed cache system.
protected $hijack = false;
protected $object_id = 0;
protected $embed_args = array();
protected $object_type = 'post';
protected $ajax_update = false;
/**
* Instance of this class.
*
* @since 2.2.2
* @var object
*/
protected static $instance;
/**
* Get the singleton instance of this class.
*
* @since 2.2.2
* @return CMB2_Ajax
*/
public static function get_instance() {
if ( ! ( self::$instance instanceof self ) ) {
self::$instance = new self();
}
return self::$instance;
}
/**
* Constructor
*
* @since 2.2.0
*/
protected function __construct() {
add_action( 'wp_ajax_cmb2_oembed_handler', array( $this, 'oembed_handler' ) );
add_action( 'wp_ajax_nopriv_cmb2_oembed_handler', array( $this, 'oembed_handler' ) );
// Need to occasionally clean stale oembed cache data from the option value.
add_action( 'cmb2_save_options-page_fields', array( __CLASS__, 'clean_stale_options_page_oembeds' ) );
}
/**
* Handles our oEmbed ajax request
*
* @since 0.9.5
* @return mixed oEmbed embed code | fallback | error message
*/
public function oembed_handler() {
// Verify our nonce.
if ( ! ( isset( $_REQUEST['cmb2_ajax_nonce'], $_REQUEST['oembed_url'] ) && wp_verify_nonce( $_REQUEST['cmb2_ajax_nonce'], 'ajax_nonce' ) ) ) {
die();
}
// Sanitize our search string.
$oembed_string = sanitize_text_field( $_REQUEST['oembed_url'] );
// Send back error if empty.
if ( empty( $oembed_string ) ) {
wp_send_json_error( '<p class="ui-state-error-text">' . esc_html__( 'Please Try Again', 'cmb2' ) . '</p>' );
}
// Set width of embed.
$embed_width = isset( $_REQUEST['oembed_width'] ) && intval( $_REQUEST['oembed_width'] ) < 640 ? intval( $_REQUEST['oembed_width'] ) : '640';
// Set url.
$oembed_url = esc_url( $oembed_string );
// Set args.
$embed_args = array(
'width' => $embed_width,
);
$this->ajax_update = true;
// Get embed code (or fallback link).
$html = $this->get_oembed( array(
'url' => $oembed_url,
'object_id' => $_REQUEST['object_id'],
'object_type' => isset( $_REQUEST['object_type'] ) ? $_REQUEST['object_type'] : 'post',
'oembed_args' => $embed_args,
'field_id' => $_REQUEST['field_id'],
) );
wp_send_json_success( $html );
}
/**
* Retrieves oEmbed from url/object ID
*
* @since 0.9.5
* @param array $args Arguments for method.
* @return mixed HTML markup with embed or fallback.
*/
public function get_oembed_no_edit( $args ) {
global $wp_embed;
$oembed_url = esc_url( $args['url'] );
// Sanitize object_id.
$this->object_id = is_numeric( $args['object_id'] ) ? absint( $args['object_id'] ) : sanitize_text_field( $args['object_id'] );
$args = wp_parse_args( $args, array(
'object_type' => 'post',
'oembed_args' => array(),
'field_id' => false,
'wp_error' => false,
) );
$this->embed_args =& $args;
/*
* Set the post_ID so oEmbed won't fail
* wp-includes/class-wp-embed.php, WP_Embed::shortcode()
*/
$wp_embed->post_ID = $this->object_id;
// Special scenario if NOT a post object.
if ( isset( $args['object_type'] ) && 'post' != $args['object_type'] ) {
if ( 'options-page' == $args['object_type'] ) {
// Bogus id to pass some numeric checks. Issue with a VERY large WP install?
$wp_embed->post_ID = 1987645321;
}
// Ok, we need to hijack the oembed cache system.
$this->hijack = true;
$this->object_type = $args['object_type'];
// Gets ombed cache from our object's meta (vs postmeta).
add_filter( 'get_post_metadata', array( $this, 'hijack_oembed_cache_get' ), 10, 3 );
// Sets ombed cache in our object's meta (vs postmeta).
add_filter( 'update_post_metadata', array( $this, 'hijack_oembed_cache_set' ), 10, 4 );
}
$embed_args = '';
foreach ( $args['oembed_args'] as $key => $val ) {
$embed_args .= " $key=\"$val\"";
}
// Ping WordPress for an embed.
$embed = $wp_embed->run_shortcode( '[embed' . $embed_args . ']' . $oembed_url . '[/embed]' );
// Fallback that WordPress creates when no oEmbed was found.
$fallback = $wp_embed->maybe_make_link( $oembed_url );
return compact( 'embed', 'fallback', 'args' );
}
/**
* Retrieves oEmbed from url/object ID
*
* @since 0.9.5
* @param array $args Arguments for method.
* @return string HTML markup with embed or fallback.
*/
public function get_oembed( $args ) {
$oembed = $this->get_oembed_no_edit( $args );
// Send back our embed.
if ( $oembed['embed'] && $oembed['embed'] != $oembed['fallback'] ) {
return '<div class="cmb2-oembed embed-status">' . $oembed['embed'] . '<p class="cmb2-remove-wrapper"><a href="#" class="cmb2-remove-file-button" rel="' . $oembed['args']['field_id'] . '">' . esc_html__( 'Remove Embed', 'cmb2' ) . '</a></p></div>';
}
// Otherwise, send back error info that no oEmbeds were found.
return sprintf(
'<p class="ui-state-error-text">%s</p>',
sprintf(
/* translators: 1: results for. 2: link to codex.wordpress.org/Embeds */
esc_html__( 'No oEmbed Results Found for %1$s. View more info at %2$s.', 'cmb2' ),
$oembed['fallback'],
'<a href="https://wordpress.org/support/article/embeds/" target="_blank">codex.wordpress.org/Embeds</a>'
)
);
}
/**
* Hijacks retrieving of cached oEmbed.
* Returns cached data from relevant object metadata (vs postmeta)
*
* @since 0.9.5
* @param boolean $check Whether to retrieve postmeta or override.
* @param int $object_id Object ID.
* @param string $meta_key Object metakey.
* @return mixed Object's oEmbed cached data.
*/
public function hijack_oembed_cache_get( $check, $object_id, $meta_key ) {
if ( ! $this->hijack || ( $this->object_id != $object_id && 1987645321 !== $object_id ) ) {
return $check;
}
if ( $this->ajax_update ) {
return false;
}
return $this->cache_action( $meta_key );
}
/**
* Hijacks saving of cached oEmbed.
* Saves cached data to relevant object metadata (vs postmeta)
*
* @since 0.9.5
* @param boolean $check Whether to continue setting postmeta.
* @param int $object_id Object ID to get postmeta from.
* @param string $meta_key Postmeta's key.
* @param mixed $meta_value Value of the postmeta to be saved.
* @return boolean Whether to continue setting.
*/
public function hijack_oembed_cache_set( $check, $object_id, $meta_key, $meta_value ) {
if (
! $this->hijack
|| ( $this->object_id != $object_id && 1987645321 !== $object_id )
// Only want to hijack oembed meta values.
|| 0 !== strpos( $meta_key, '_oembed_' )
) {
return $check;
}
$this->cache_action( $meta_key, $meta_value );
// Anything other than `null` to cancel saving to postmeta.
return true;
}
/**
* Gets/updates the cached oEmbed value from/to relevant object metadata (vs postmeta).
*
* @since 1.3.0
*
* @param string $meta_key Postmeta's key.
* @return mixed
*/
protected function cache_action( $meta_key ) {
$func_args = func_get_args();
$action = isset( $func_args[1] ) ? 'update' : 'get';
if ( 'options-page' === $this->object_type ) {
$args = array( $meta_key );
if ( 'update' === $action ) {
$args[] = $func_args[1];
$args[] = true;
}
// Cache the result to our options.
$status = call_user_func_array( array( cmb2_options( $this->object_id ), $action ), $args );
} else {
$args = array( $this->object_type, $this->object_id, $meta_key );
$args[] = 'update' === $action ? $func_args[1] : true;
// Cache the result to our metadata.
$status = call_user_func_array( $action . '_metadata', $args );
}
return $status;
}
/**
* Hooks in when options-page data is saved to clean stale
* oembed cache data from the option value.
*
* @since 2.2.0
* @param string $option_key The options-page option key.
* @return void
*/
public static function clean_stale_options_page_oembeds( $option_key ) {
$options = cmb2_options( $option_key )->get_options();
$modified = false;
if ( is_array( $options ) ) {
$ttl = apply_filters( 'oembed_ttl', DAY_IN_SECONDS, '', array(), 0 );
$now = time();
foreach ( $options as $key => $value ) {
// Check for cached oembed data.
if ( 0 === strpos( $key, '_oembed_time_' ) ) {
$cached_recently = ( $now - $value ) < $ttl;
if ( ! $cached_recently ) {
$modified = true;
// Remove the the cached ttl expiration, and the cached oembed value.
unset( $options[ $key ] );
unset( $options[ str_replace( '_oembed_time_', '_oembed_', $key ) ] );
}
} // End if.
// Remove the cached unknown values.
elseif ( '{{unknown}}' === $value ) {
$modified = true;
unset( $options[ $key ] );
}
}
}
// Update the option and remove stale cache data.
if ( $modified ) {
$updated = cmb2_options( $option_key )->set( $options );
}
}
}

View File

@ -0,0 +1,534 @@
<?php
/**
* CMB2 Base - Base object functionality.
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*
* @property-read $args The objects array of properties/arguments.
* @property-read $meta_box The objects array of properties/arguments.
* @property-read $properties The objects array of properties/arguments.
* @property-read $cmb_id Current CMB2 instance ID
* @property-read $object_id Object ID
* @property-read $object_type Type of object being handled. (e.g., post, user, comment, or term)
*/
abstract class CMB2_Base {
/**
* Current CMB2 instance ID
*
* @var string
* @since 2.2.3
*/
protected $cmb_id = '';
/**
* The object properties name.
*
* @var string
* @since 2.2.3
*/
protected $properties_name = 'meta_box';
/**
* Object ID
*
* @var mixed
* @since 2.2.3
*/
protected $object_id = 0;
/**
* Type of object being handled. (e.g., post, user, comment, or term)
*
* @var string
* @since 2.2.3
*/
protected $object_type = '';
/**
* Array of key => value data for saving. Likely $_POST data.
*
* @var array
* @since 2.2.3
*/
public $data_to_save = array();
/**
* Array of field param callback results
*
* @var array
* @since 2.0.0
*/
protected $callback_results = array();
/**
* The deprecated_param method deprecated param message signature.
*/
const DEPRECATED_PARAM = 1;
/**
* The deprecated_param method deprecated callback param message signature.
*/
const DEPRECATED_CB_PARAM = 2;
/**
* Get started
*
* @since 2.2.3
* @param array $args Object properties array.
*/
public function __construct( $args = array() ) {
if ( ! empty( $args ) ) {
foreach ( array(
'cmb_id',
'properties_name',
'object_id',
'object_type',
'data_to_save',
) as $object_prop ) {
if ( isset( $args[ $object_prop ] ) ) {
$this->{$object_prop} = $args[ $object_prop ];
}
}
}
}
/**
* Returns the object ID
*
* @since 2.2.3
* @param integer $object_id Object ID.
* @return integer Object ID
*/
public function object_id( $object_id = 0 ) {
if ( $object_id ) {
$this->object_id = $object_id;
}
return $this->object_id;
}
/**
* Returns the object type
*
* @since 2.2.3
* @param string $object_type Object Type.
* @return string Object type
*/
public function object_type( $object_type = '' ) {
if ( $object_type ) {
$this->object_type = $object_type;
}
return $this->object_type;
}
/**
* Get the object type for the current page, based on the $pagenow global.
*
* @since 2.2.2
* @return string Page object type name.
*/
public function current_object_type() {
global $pagenow;
$type = 'post';
if ( in_array( $pagenow, array( 'user-edit.php', 'profile.php', 'user-new.php' ), true ) ) {
$type = 'user';
}
if ( in_array( $pagenow, array( 'edit-comments.php', 'comment.php' ), true ) ) {
$type = 'comment';
}
if ( in_array( $pagenow, array( 'edit-tags.php', 'term.php' ), true ) ) {
$type = 'term';
}
return $type;
}
/**
* Set object property.
*
* @since 2.2.2
* @param string $property Metabox config property to retrieve.
* @param mixed $value Value to set if no value found.
* @return mixed Metabox config property value or false.
*/
public function set_prop( $property, $value ) {
$this->{$this->properties_name}[ $property ] = $value;
return $this->prop( $property );
}
/**
* Get object property and optionally set a fallback
*
* @since 2.0.0
* @param string $property Metabox config property to retrieve.
* @param mixed $fallback Fallback value to set if no value found.
* @return mixed Metabox config property value or false
*/
public function prop( $property, $fallback = null ) {
if ( array_key_exists( $property, $this->{$this->properties_name} ) ) {
return $this->{$this->properties_name}[ $property ];
} elseif ( $fallback ) {
return $this->{$this->properties_name}[ $property ] = $fallback;
}
}
/**
* Get default field arguments specific to this CMB2 object.
*
* @since 2.2.0
* @param array $field_args Metabox field config array.
* @param CMB2_Field $field_group (optional) CMB2_Field object (group parent).
* @return array Array of field arguments.
*/
protected function get_default_args( $field_args, $field_group = null ) {
if ( $field_group ) {
$args = array(
'field_args' => $field_args,
'group_field' => $field_group,
);
} else {
$args = array(
'field_args' => $field_args,
'object_type' => $this->object_type(),
'object_id' => $this->object_id(),
'cmb_id' => $this->cmb_id,
);
}
return $args;
}
/**
* Get a new field object specific to this CMB2 object.
*
* @since 2.2.0
* @param array $field_args Metabox field config array.
* @param CMB2_Field $field_group (optional) CMB2_Field object (group parent).
* @return CMB2_Field CMB2_Field object
*/
protected function get_new_field( $field_args, $field_group = null ) {
return new CMB2_Field( $this->get_default_args( $field_args, $field_group ) );
}
/**
* Determine whether this cmb object should show, based on the 'show_on_cb' callback.
*
* @since 2.0.9
*
* @return bool Whether this cmb should be shown.
*/
public function should_show() {
// Default to showing this cmb
$show = true;
// Use the callback to determine showing the cmb, if it exists.
if ( is_callable( $this->prop( 'show_on_cb' ) ) ) {
$show = (bool) call_user_func( $this->prop( 'show_on_cb' ), $this );
}
return $show;
}
/**
* Displays the results of the param callbacks.
*
* @since 2.0.0
* @param string $param Field parameter.
*/
public function peform_param_callback( $param ) {
echo $this->get_param_callback_result( $param );
}
/**
* Store results of the param callbacks for continual access
*
* @since 2.0.0
* @param string $param Field parameter.
* @return mixed Results of param/param callback
*/
public function get_param_callback_result( $param ) {
// If we've already retrieved this param's value.
if ( array_key_exists( $param, $this->callback_results ) ) {
// Send it back.
return $this->callback_results[ $param ];
}
// Check if parameter has registered a callback.
if ( $cb = $this->maybe_callback( $param ) ) {
// Ok, callback is good, let's run it and store the result.
ob_start();
$returned = $this->do_callback( $cb );
// Grab the result from the output buffer and store it.
$echoed = ob_get_clean();
// This checks if the user returned or echoed their callback.
// Defaults to using the echoed value.
$this->callback_results[ $param ] = $echoed ? $echoed : $returned;
} else {
// Otherwise just get whatever is there.
$this->callback_results[ $param ] = isset( $this->{$this->properties_name}[ $param ] ) ? $this->{$this->properties_name}[ $param ] : false;
}
return $this->callback_results[ $param ];
}
/**
* Unset the cached results of the param callback.
*
* @since 2.2.6
* @param string $param Field parameter.
* @return CMB2_Base
*/
public function unset_param_callback_cache( $param ) {
if ( isset( $this->callback_results[ $param ] ) ) {
unset( $this->callback_results[ $param ] );
}
return $this;
}
/**
* Handles the parameter callbacks, and passes this object as parameter.
*
* @since 2.2.3
* @param callable $cb The callback method/function/closure.
* @param mixed $additional_params Any additoinal parameters which should be passed to the callback.
* @return mixed Return of the callback function.
*/
protected function do_callback( $cb, $additional_params = null ) {
return call_user_func( $cb, $this->{$this->properties_name}, $this, $additional_params );
}
/**
* Checks if field has a callback value
*
* @since 1.0.1
* @param string $cb Callback string.
* @return mixed NULL, false for NO validation, or $cb string if it exists.
*/
public function maybe_callback( $cb ) {
$args = $this->{$this->properties_name};
if ( ! isset( $args[ $cb ] ) ) {
return null;
}
// Check if requesting explicitly false.
$cb = false !== $args[ $cb ] && 'false' !== $args[ $cb ] ? $args[ $cb ] : false;
// If requesting NO validation, return false.
if ( ! $cb ) {
return false;
}
if ( is_callable( $cb ) ) {
return $cb;
}
return null;
}
/**
* Checks if this object has parameter corresponding to the given filter
* which is callable. If so, it registers the callback, and if not,
* converts the maybe-modified $val to a boolean for return.
*
* The registered handlers will have a parameter name which matches the filter, except:
* - The 'cmb2_api' prefix will be removed
* - A '_cb' suffix will be added (to stay inline with other '*_cb' parameters).
*
* @since 2.2.3
*
* @param string $hook_name The hook name.
* @param bool $val The default value.
* @param string $hook_function The hook function. Default: 'add_filter'.
*
* @return null|bool Null if hook is registered, or bool for value.
*/
public function maybe_hook_parameter( $hook_name, $val = null, $hook_function = 'add_filter' ) {
// Remove filter prefix, add param suffix.
$parameter = substr( $hook_name, strlen( 'cmb2_api_' ) ) . '_cb';
return self::maybe_hook(
$this->prop( $parameter, $val ),
$hook_name,
$hook_function
);
}
/**
* Checks if given value is callable, and registers the callback.
* If is non-callable, converts the $val to a boolean for return.
*
* @since 2.2.3
*
* @param bool $val The default value.
* @param string $hook_name The hook name.
* @param string $hook_function The hook function.
*
* @return null|bool Null if hook is registered, or bool for value.
*/
public static function maybe_hook( $val, $hook_name, $hook_function ) {
if ( is_callable( $val ) ) {
call_user_func( $hook_function, $hook_name, $val, 10, 2 );
return null;
}
// Cast to bool.
return ! ! $val;
}
/**
* Mark a param as deprecated and inform when it has been used.
*
* There is a default WordPress hook deprecated_argument_run that will be called
* that can be used to get the backtrace up to what file and function used the
* deprecated argument.
*
* The current behavior is to trigger a user error if WP_DEBUG is true.
*
* @since 2.2.3
*
* @param string $function The function that was called.
* @param string $version The version of CMB2 that deprecated the argument used.
* @param string $message Optional. A message regarding the change, or numeric
* key to generate message from additional arguments.
* Default null.
*/
protected function deprecated_param( $function, $version, $message = null ) {
$args = func_get_args();
if ( is_numeric( $message ) ) {
switch ( $message ) {
case self::DEPRECATED_PARAM:
$message = sprintf( __( 'The "%1$s" field parameter has been deprecated in favor of the "%2$s" parameter.', 'cmb2' ), $args[3], $args[4] );
break;
case self::DEPRECATED_CB_PARAM:
$message = sprintf( __( 'Using the "%1$s" field parameter as a callback has been deprecated in favor of the "%2$s" parameter.', 'cmb2' ), $args[3], $args[4] );
break;
default:
$message = null;
break;
}
}
/**
* Fires when a deprecated argument is called. This is a WP core action.
*
* @since 2.2.3
*
* @param string $function The function that was called.
* @param string $message A message regarding the change.
* @param string $version The version of CMB2 that deprecated the argument used.
*/
do_action( 'deprecated_argument_run', $function, $message, $version );
/**
* Filters whether to trigger an error for deprecated arguments. This is a WP core filter.
*
* @since 2.2.3
*
* @param bool $trigger Whether to trigger the error for deprecated arguments. Default true.
*/
if ( defined( 'WP_DEBUG' ) && WP_DEBUG && apply_filters( 'deprecated_argument_trigger_error', true ) ) {
if ( function_exists( '__' ) ) {
if ( ! is_null( $message ) ) {
trigger_error( sprintf( __( '%1$s was called with a parameter that is <strong>deprecated</strong> since version %2$s! %3$s', 'cmb2' ), $function, $version, $message ) );
} else {
trigger_error( sprintf( __( '%1$s was called with a parameter that is <strong>deprecated</strong> since version %2$s with no alternative available.', 'cmb2' ), $function, $version ) );
}
} else {
if ( ! is_null( $message ) ) {
trigger_error( sprintf( '%1$s was called with a parameter that is <strong>deprecated</strong> since version %2$s! %3$s', $function, $version, $message ) );
} else {
trigger_error( sprintf( '%1$s was called with a parameter that is <strong>deprecated</strong> since version %2$s with no alternative available.', $function, $version ) );
}
}
}
}
/**
* Magic getter for our object.
*
* @param string $field Requested property.
* @throws Exception Throws an exception if the field is invalid.
* @return mixed
*/
public function __get( $field ) {
switch ( $field ) {
case 'args':
case 'meta_box':
if ( $field === $this->properties_name ) {
return $this->{$this->properties_name};
}
case 'properties':
return $this->{$this->properties_name};
case 'cmb_id':
case 'object_id':
case 'object_type':
return $this->{$field};
default:
throw new Exception( sprintf( esc_html__( 'Invalid %1$s property: %2$s', 'cmb2' ), __CLASS__, $field ) );
}
}
/**
* Allows overloading the object with methods... Whooaaa oooh it's magic, y'knoooow.
*
* @since 1.0.0
* @throws Exception Invalid method exception.
*
* @param string $method Non-existent method.
* @param array $args All arguments passed to the method.
* @return mixed
*/
public function __call( $method, $args ) {
$object_class = strtolower( get_class( $this ) );
if ( ! has_filter( "{$object_class}_inherit_{$method}" ) ) {
throw new Exception( sprintf( esc_html__( 'Invalid %1$s method: %2$s', 'cmb2' ), get_class( $this ), $method ) );
}
array_unshift( $args, $this );
/**
* Allows overloading the object (CMB2 or CMB2_Field) with additional capabilities
* by registering hook callbacks.
*
* The first dynamic portion of the hook name, $object_class, refers to the object class,
* either cmb2 or cmb2_field.
*
* The second dynamic portion of the hook name, $method, is the non-existent method being
* called on the object. To avoid possible future methods encroaching on your hooks,
* use a unique method (aka, $cmb->prefix_my_method()).
*
* When registering your callback, you will need to ensure that you register the correct
* number of `$accepted_args`, accounting for this object instance being the first argument.
*
* @param array $args The arguments to be passed to the hook.
* The first argument will always be this object instance.
*/
return apply_filters_ref_array( "{$object_class}_inherit_{$method}", $args );
}
}

View File

@ -0,0 +1,139 @@
<?php
/**
* A CMB2 object instance registry for storing every CMB2 instance.
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Boxes {
/**
* Array of all metabox objects.
*
* @since 2.0.0
* @var array
*/
protected static $cmb2_instances = array();
/**
* Add a CMB2 instance object to the registry.
*
* @since 1.X.X
*
* @param CMB2 $cmb_instance CMB2 instance.
*/
public static function add( CMB2 $cmb_instance ) {
self::$cmb2_instances[ $cmb_instance->cmb_id ] = $cmb_instance;
}
/**
* Remove a CMB2 instance object from the registry.
*
* @since 1.X.X
*
* @param string $cmb_id A CMB2 instance id.
*/
public static function remove( $cmb_id ) {
if ( array_key_exists( $cmb_id, self::$cmb2_instances ) ) {
unset( self::$cmb2_instances[ $cmb_id ] );
}
}
/**
* Retrieve a CMB2 instance by cmb id.
*
* @since 1.X.X
*
* @param string $cmb_id A CMB2 instance id.
*
* @return CMB2|bool False or CMB2 object instance.
*/
public static function get( $cmb_id ) {
if ( empty( self::$cmb2_instances ) || empty( self::$cmb2_instances[ $cmb_id ] ) ) {
return false;
}
return self::$cmb2_instances[ $cmb_id ];
}
/**
* Retrieve all CMB2 instances registered.
*
* @since 1.X.X
* @return CMB2[] Array of all registered cmb2 instances.
*/
public static function get_all() {
return self::$cmb2_instances;
}
/**
* Retrieve all CMB2 instances that have the specified property set.
*
* @since 2.4.0
* @param string $property Property name.
* @param mixed $compare (Optional) The value to compare.
* @return CMB2[] Array of matching cmb2 instances.
*/
public static function get_by( $property, $compare = 'nocompare' ) {
$boxes = array();
foreach ( self::$cmb2_instances as $cmb_id => $cmb ) {
$prop = $cmb->prop( $property );
if ( 'nocompare' === $compare ) {
if ( ! empty( $prop ) ) {
$boxes[ $cmb_id ] = $cmb;
}
continue;
}
if ( $compare === $prop ) {
$boxes[ $cmb_id ] = $cmb;
}
}
return $boxes;
}
/**
* Retrieve all CMB2 instances as long as they do not include the ignored property.
*
* @since 2.4.0
* @param string $property Property name.
* @param mixed $to_ignore The value to ignore.
* @return CMB2[] Array of matching cmb2 instances.
*/
public static function filter_by( $property, $to_ignore = null ) {
$boxes = array();
foreach ( self::$cmb2_instances as $cmb_id => $cmb ) {
if ( $to_ignore === $cmb->prop( $property ) ) {
continue;
}
$boxes[ $cmb_id ] = $cmb;
}
return $boxes;
}
/**
* Deprecated and left for back-compatibility. The original `get_by_property`
* method was misnamed and never actually used by CMB2 core.
*
* @since 2.2.3
*
* @param string $property Property name.
* @param mixed $to_ignore The value to ignore.
* @return CMB2[] Array of matching cmb2 instances.
*/
public static function get_by_property( $property, $to_ignore = null ) {
_deprecated_function( __METHOD__, '2.4.0', 'CMB2_Boxes::filter_by()' );
return self::filter_by( $property );
}
}

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,505 @@
<?php
/**
* CMB2 field display base.
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Field_Display {
/**
* A CMB field object
*
* @var CMB2_Field object
* @since 2.2.2
*/
public $field;
/**
* The CMB field object's value.
*
* @var mixed
* @since 2.2.2
*/
public $value;
/**
* Get the corresponding display class for the field type.
*
* @since 2.2.2
* @param CMB2_Field $field Requested field type.
* @return CMB2_Field_Display
*/
public static function get( CMB2_Field $field ) {
$fieldtype = $field->type();
$display_class_name = $field->args( 'display_class' );
if ( empty( $display_class_name ) ) {
switch ( $fieldtype ) {
case 'text_url':
$display_class_name = 'CMB2_Display_Text_Url';
break;
case 'text_money':
$display_class_name = 'CMB2_Display_Text_Money';
break;
case 'colorpicker':
$display_class_name = 'CMB2_Display_Colorpicker';
break;
case 'checkbox':
$display_class_name = 'CMB2_Display_Checkbox';
break;
case 'wysiwyg':
case 'textarea_small':
$display_class_name = 'CMB2_Display_Textarea';
break;
case 'textarea_code':
$display_class_name = 'CMB2_Display_Textarea_Code';
break;
case 'text_time':
$display_class_name = 'CMB2_Display_Text_Time';
break;
case 'text_date':
case 'text_date_timestamp':
case 'text_datetime_timestamp':
$display_class_name = 'CMB2_Display_Text_Date';
break;
case 'text_datetime_timestamp_timezone':
$display_class_name = 'CMB2_Display_Text_Date_Timezone';
break;
case 'select':
case 'radio':
case 'radio_inline':
$display_class_name = 'CMB2_Display_Select';
break;
case 'multicheck':
case 'multicheck_inline':
$display_class_name = 'CMB2_Display_Multicheck';
break;
case 'taxonomy_radio':
case 'taxonomy_radio_inline':
case 'taxonomy_select':
case 'taxonomy_select_hierarchical':
case 'taxonomy_radio_hierarchical':
$display_class_name = 'CMB2_Display_Taxonomy_Radio';
break;
case 'taxonomy_multicheck':
case 'taxonomy_multicheck_inline':
case 'taxonomy_multicheck_hierarchical':
$display_class_name = 'CMB2_Display_Taxonomy_Multicheck';
break;
case 'file':
$display_class_name = 'CMB2_Display_File';
break;
case 'file_list':
$display_class_name = 'CMB2_Display_File_List';
break;
case 'oembed':
$display_class_name = 'CMB2_Display_oEmbed';
break;
default:
$display_class_name = __CLASS__;
break;
}// End switch.
}
if ( has_action( "cmb2_display_class_{$fieldtype}" ) ) {
/**
* Filters the custom field display class used for displaying the field. Class is required to extend CMB2_Type_Base.
*
* The dynamic portion of the hook name, $fieldtype, refers to the (custom) field type.
*
* @since 2.2.4
*
* @param string $display_class_name The custom field display class to use.
* @param object $field The `CMB2_Field` object.
*/
$display_class_name = apply_filters( "cmb2_display_class_{$fieldtype}", $display_class_name, $field );
}
return new $display_class_name( $field );
}
/**
* Setup our class vars
*
* @since 2.2.2
* @param CMB2_Field $field A CMB2 field object.
*/
public function __construct( CMB2_Field $field ) {
$this->field = $field;
$this->value = $this->field->value;
}
/**
* Catchall method if field's 'display_cb' is NOT defined, or field type does
* not have a corresponding display method
*
* @since 2.2.2
*/
public function display() {
// If repeatable.
if ( $this->field->args( 'repeatable' ) ) {
// And has a repeatable value.
if ( is_array( $this->field->value ) ) {
// Then loop and output.
echo '<ul class="cmb2-' . esc_attr( sanitize_html_class( str_replace( '_', '-', $this->field->type() ) ) ) . '">';
foreach ( $this->field->value as $val ) {
$this->value = $val;
echo '<li>', $this->_display(), '</li>';
;
}
echo '</ul>';
}
} else {
$this->_display();
}
}
/**
* Default fallback display method.
*
* @since 2.2.2
*/
protected function _display() {
print_r( $this->value );
}
}
class CMB2_Display_Text_Url extends CMB2_Field_Display {
/**
* Display url value.
*
* @since 2.2.2
*/
protected function _display() {
echo make_clickable( esc_url( $this->value ) );
}
}
class CMB2_Display_Text_Money extends CMB2_Field_Display {
/**
* Display text_money value.
*
* @since 2.2.2
*/
protected function _display() {
$this->value = $this->value ? $this->value : '0';
echo ( ! $this->field->get_param_callback_result( 'before_field' ) ? '$' : ' ' ), $this->value;
}
}
class CMB2_Display_Colorpicker extends CMB2_Field_Display {
/**
* Display color picker value.
*
* @since 2.2.2
*/
protected function _display() {
echo '<span class="cmb2-colorpicker-swatch"><span style="background-color:', esc_attr( $this->value ), '"></span> ', esc_html( $this->value ), '</span>';
}
}
class CMB2_Display_Checkbox extends CMB2_Field_Display {
/**
* Display multicheck value.
*
* @since 2.2.2
*/
protected function _display() {
echo $this->value === 'on' ? 'on' : 'off';
}
}
class CMB2_Display_Select extends CMB2_Field_Display {
/**
* Display select value.
*
* @since 2.2.2
*/
protected function _display() {
$options = $this->field->options();
$fallback = $this->field->args( 'show_option_none' );
if ( ! $fallback && isset( $options[''] ) ) {
$fallback = $options[''];
}
if ( ! $this->value && $fallback ) {
echo $fallback;
} elseif ( isset( $options[ $this->value ] ) ) {
echo $options[ $this->value ];
} else {
echo esc_attr( $this->value );
}
}
}
class CMB2_Display_Multicheck extends CMB2_Field_Display {
/**
* Display multicheck value.
*
* @since 2.2.2
*/
protected function _display() {
if ( empty( $this->value ) || ! is_array( $this->value ) ) {
return;
}
$options = $this->field->options();
$output = array();
foreach ( $this->value as $val ) {
if ( isset( $options[ $val ] ) ) {
$output[] = $options[ $val ];
} else {
$output[] = esc_attr( $val );
}
}
echo implode( ', ', $output );
}
}
class CMB2_Display_Textarea extends CMB2_Field_Display {
/**
* Display textarea value.
*
* @since 2.2.2
*/
protected function _display() {
echo wpautop( wp_kses_post( $this->value ) );
}
}
class CMB2_Display_Textarea_Code extends CMB2_Field_Display {
/**
* Display textarea_code value.
*
* @since 2.2.2
*/
protected function _display() {
echo '<xmp class="cmb2-code">' . print_r( $this->value, true ) . '</xmp>';
}
}
class CMB2_Display_Text_Time extends CMB2_Field_Display {
/**
* Display text_time value.
*
* @since 2.2.2
*/
protected function _display() {
echo $this->field->get_timestamp_format( 'time_format', $this->value );
}
}
class CMB2_Display_Text_Date extends CMB2_Field_Display {
/**
* Display text_date value.
*
* @since 2.2.2
*/
protected function _display() {
echo $this->field->get_timestamp_format( 'date_format', $this->value );
}
}
class CMB2_Display_Text_Date_Timezone extends CMB2_Field_Display {
/**
* Display text_datetime_timestamp_timezone value.
*
* @since 2.2.2
*/
protected function _display() {
$field = $this->field;
if ( empty( $this->value ) ) {
return;
}
$datetime = maybe_unserialize( $this->value );
$this->value = $tzstring = '';
if ( $datetime && $datetime instanceof DateTime ) {
$tz = $datetime->getTimezone();
$tzstring = $tz->getName();
$this->value = $datetime->getTimestamp();
}
$date = $this->field->get_timestamp_format( 'date_format', $this->value );
$time = $this->field->get_timestamp_format( 'time_format', $this->value );
echo $date, ( $time ? ' ' . $time : '' ), ( $tzstring ? ', ' . $tzstring : '' );
}
}
class CMB2_Display_Taxonomy_Radio extends CMB2_Field_Display {
/**
* Display single taxonomy value.
*
* @since 2.2.2
*/
protected function _display() {
$taxonomy = $this->field->args( 'taxonomy' );
$types = new CMB2_Types( $this->field );
$type = $types->get_new_render_type( $this->field->type(), 'CMB2_Type_Taxonomy_Radio' );
$terms = $type->get_object_terms();
$term = false;
if ( is_wp_error( $terms ) || empty( $terms ) && ( $default = $this->field->get_default() ) ) {
$term = get_term_by( 'slug', $default, $taxonomy );
} elseif ( ! empty( $terms ) ) {
$term = $terms[ key( $terms ) ];
}
if ( $term ) {
$link = get_edit_term_link( $term->term_id, $taxonomy );
echo '<a href="', esc_url( $link ), '">', esc_html( $term->name ), '</a>';
}
}
}
class CMB2_Display_Taxonomy_Multicheck extends CMB2_Field_Display {
/**
* Display taxonomy values.
*
* @since 2.2.2
*/
protected function _display() {
$taxonomy = $this->field->args( 'taxonomy' );
$types = new CMB2_Types( $this->field );
$type = $types->get_new_render_type( $this->field->type(), 'CMB2_Type_Taxonomy_Multicheck' );
$terms = $type->get_object_terms();
if ( is_wp_error( $terms ) || empty( $terms ) && ( $default = $this->field->get_default() ) ) {
$terms = array();
if ( is_array( $default ) ) {
foreach ( $default as $slug ) {
$terms[] = get_term_by( 'slug', $slug, $taxonomy );
}
} else {
$terms[] = get_term_by( 'slug', $default, $taxonomy );
}
}
if ( is_array( $terms ) ) {
$links = array();
foreach ( $terms as $term ) {
$link = get_edit_term_link( $term->term_id, $taxonomy );
$links[] = '<a href="' . esc_url( $link ) . '">' . esc_html( $term->name ) . '</a>';
}
// Then loop and output.
echo '<div class="cmb2-taxonomy-terms-', esc_attr( sanitize_html_class( $taxonomy ) ), '">';
echo implode( ', ', $links );
echo '</div>';
}
}
}
class CMB2_Display_File extends CMB2_Field_Display {
/**
* Display file value.
*
* @since 2.2.2
*/
protected function _display() {
if ( empty( $this->value ) ) {
return;
}
$this->value = esc_url_raw( $this->value );
$types = new CMB2_Types( $this->field );
$type = $types->get_new_render_type( $this->field->type(), 'CMB2_Type_File_Base' );
$id = $this->field->get_field_clone( array(
'id' => $this->field->_id( '', false ) . '_id',
) )->escaped_value( 'absint' );
$this->file_output( $this->value, $id, $type );
}
protected function file_output( $url_value, $id, CMB2_Type_File_Base $field_type ) {
// If there is no ID saved yet, try to get it from the url.
if ( $url_value && ! $id ) {
$id = CMB2_Utils::image_id_from_url( esc_url_raw( $url_value ) );
}
if ( $field_type->is_valid_img_ext( $url_value ) ) {
$img_size = $this->field->args( 'preview_size' );
if ( $id ) {
$image = wp_get_attachment_image( $id, $img_size, null, array(
'class' => 'cmb-image-display',
) );
} else {
$size = is_array( $img_size ) ? $img_size[0] : 200;
$image = '<img class="cmb-image-display" style="max-width: ' . absint( $size ) . 'px; width: 100%; height: auto;" src="' . esc_url( $url_value ) . '" alt="" />';
}
echo $image;
} else {
printf( '<div class="file-status"><span>%1$s <strong><a href="%2$s">%3$s</a></strong></span></div>',
esc_html( $field_type->_text( 'file_text', __( 'File:', 'cmb2' ) ) ),
esc_url( $url_value ),
esc_html( CMB2_Utils::get_file_name_from_path( $url_value ) )
);
}
}
}
class CMB2_Display_File_List extends CMB2_Display_File {
/**
* Display file_list value.
*
* @since 2.2.2
*/
protected function _display() {
if ( empty( $this->value ) || ! is_array( $this->value ) ) {
return;
}
$types = new CMB2_Types( $this->field );
$type = $types->get_new_render_type( $this->field->type(), 'CMB2_Type_File_Base' );
echo '<ul class="cmb2-display-file-list">';
foreach ( $this->value as $id => $fullurl ) {
echo '<li>', $this->file_output( esc_url_raw( $fullurl ), $id, $type ), '</li>';
}
echo '</ul>';
}
}
class CMB2_Display_oEmbed extends CMB2_Field_Display {
/**
* Display oembed value.
*
* @since 2.2.2
*/
protected function _display() {
if ( ! $this->value ) {
return;
}
cmb2_do_oembed( array(
'url' => $this->value,
'object_id' => $this->field->object_id,
'object_type' => $this->field->object_type,
'oembed_args' => array(
'width' => '300',
),
'field_id' => $this->field->id(),
) );
}
}

File diff suppressed because it is too large Load Diff

View File

@ -0,0 +1,105 @@
<?php
/**
* Base class for hooking CMB2 into WordPress.
*
* @since 2.2.0
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*
* @property-read string $object_type
* @property-read CMB2 $cmb
*/
abstract class CMB2_Hookup_Base {
/**
* CMB2 object.
*
* @var CMB2 object
* @since 2.0.2
*/
protected $cmb;
/**
* The object type we are performing the hookup for
*
* @var string
* @since 2.0.9
*/
protected $object_type = 'post';
/**
* A functionalized constructor, used for the hookup action callbacks.
*
* @since 2.2.6
*
* @throws Exception Failed implementation.
*
* @param CMB2 $cmb The CMB2 object to hookup.
*/
public static function maybe_init_and_hookup( CMB2 $cmb ) {
throw new Exception( sprintf( esc_html__( '%1$s should be implemented by the extended class.', 'cmb2' ), __FUNCTION__ ) );
}
/**
* Constructor
*
* @since 2.0.0
* @param CMB2 $cmb The CMB2 object to hookup.
*/
public function __construct( CMB2 $cmb ) {
$this->cmb = $cmb;
$this->object_type = $this->cmb->mb_object_type();
}
abstract public function universal_hooks();
/**
* Ensures WordPress hook only gets fired once per object.
*
* @since 2.0.0
* @param string $action The name of the filter to hook the $hook callback to.
* @param callback $hook The callback to be run when the filter is applied.
* @param integer $priority Order the functions are executed.
* @param int $accepted_args The number of arguments the function accepts.
*/
public function once( $action, $hook, $priority = 10, $accepted_args = 1 ) {
static $hooks_completed = array();
$args = func_get_args();
// Get object hash.. This bypasses issues with serializing closures.
if ( is_object( $hook ) ) {
$args[1] = spl_object_hash( $args[1] );
} elseif ( is_array( $hook ) && is_object( $hook[0] ) ) {
$args[1][0] = spl_object_hash( $hook[0] );
}
$key = md5( serialize( $args ) );
if ( ! isset( $hooks_completed[ $key ] ) ) {
$hooks_completed[ $key ] = 1;
add_filter( $action, $hook, $priority, $accepted_args );
}
}
/**
* Magic getter for our object.
*
* @param string $field Property to return.
* @throws Exception Throws an exception if the field is invalid.
* @return mixed
*/
public function __get( $field ) {
switch ( $field ) {
case 'object_type':
case 'cmb':
return $this->{$field};
default:
throw new Exception( sprintf( esc_html__( 'Invalid %1$s property: %2$s', 'cmb2' ), __CLASS__, $field ) );
}
}
}

View File

@ -0,0 +1,257 @@
<?php
/**
* Handles the dependencies and enqueueing of the CMB2 JS scripts
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_JS {
/**
* The CMB2 JS handle
*
* @var string
* @since 2.0.7
*/
protected static $handle = 'cmb2-scripts';
/**
* The CMB2 JS variable name
*
* @var string
* @since 2.0.7
*/
protected static $js_variable = 'cmb2_l10';
/**
* Array of CMB2 JS dependencies
*
* @var array
* @since 2.0.7
*/
protected static $dependencies = array(
'jquery' => 'jquery',
);
/**
* Array of CMB2 fields model data for JS.
*
* @var array
* @since 2.4.0
*/
protected static $fields = array();
/**
* Add a dependency to the array of CMB2 JS dependencies
*
* @since 2.0.7
* @param array|string $dependencies Array (or string) of dependencies to add.
*/
public static function add_dependencies( $dependencies ) {
foreach ( (array) $dependencies as $dependency ) {
self::$dependencies[ $dependency ] = $dependency;
}
}
/**
* Add field model data to the array for JS.
*
* @since 2.4.0
*
* @param CMB2_Field $field Field object.
*/
public static function add_field_data( CMB2_Field $field ) {
$hash = $field->hash_id();
if ( ! isset( self::$fields[ $hash ] ) ) {
self::$fields[ $hash ] = $field->js_data();
}
}
/**
* Enqueue the CMB2 JS
*
* @since 2.0.7
*/
public static function enqueue() {
// Filter required script dependencies.
$dependencies = self::$dependencies = apply_filters( 'cmb2_script_dependencies', self::$dependencies );
// Only use minified files if SCRIPT_DEBUG is off.
$debug = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG;
$min = $debug ? '' : '.min';
// if colorpicker.
if ( isset( $dependencies['wp-color-picker'] ) ) {
if ( ! is_admin() ) {
self::colorpicker_frontend();
}
// Enqueue colorpicker
if ( ! wp_script_is( 'wp-color-picker', 'enqueued' ) ) {
wp_enqueue_script( 'wp-color-picker' );
}
if ( isset( $dependencies['wp-color-picker-alpha'] ) ) {
self::register_colorpicker_alpha();
}
}
// if file/file_list.
if ( isset( $dependencies['media-editor'] ) ) {
wp_enqueue_media();
CMB2_Type_File_Base::output_js_underscore_templates();
}
// if timepicker.
if ( isset( $dependencies['jquery-ui-datetimepicker'] ) ) {
self::register_datetimepicker();
}
// if cmb2-wysiwyg.
$enqueue_wysiwyg = isset( $dependencies['cmb2-wysiwyg'] ) && $debug;
unset( $dependencies['cmb2-wysiwyg'] );
// if cmb2-char-counter.
$enqueue_char_counter = isset( $dependencies['cmb2-char-counter'] ) && $debug;
unset( $dependencies['cmb2-char-counter'] );
// Enqueue cmb JS.
wp_enqueue_script( self::$handle, CMB2_Utils::url( "js/cmb2{$min}.js" ), array_values( $dependencies ), CMB2_VERSION, true );
// if SCRIPT_DEBUG, we need to enqueue separately.
if ( $enqueue_wysiwyg ) {
wp_enqueue_script( 'cmb2-wysiwyg', CMB2_Utils::url( 'js/cmb2-wysiwyg.js' ), array( 'jquery', 'wp-util' ), CMB2_VERSION );
}
if ( $enqueue_char_counter ) {
wp_enqueue_script( 'cmb2-char-counter', CMB2_Utils::url( 'js/cmb2-char-counter.js' ), array( 'jquery', 'wp-util' ), CMB2_VERSION );
}
self::localize( $debug );
do_action( 'cmb2_footer_enqueue' );
}
/**
* Register or enqueue the wp-color-picker-alpha script.
*
* @since 2.2.7
*
* @param boolean $enqueue Whether or not to enqueue.
*
* @return void
*/
public static function register_colorpicker_alpha( $enqueue = false ) {
// Only use minified files if SCRIPT_DEBUG is off.
$min = defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ? '' : '.min';
$func = $enqueue ? 'wp_enqueue_script' : 'wp_register_script';
$func( 'wp-color-picker-alpha', CMB2_Utils::url( "js/wp-color-picker-alpha{$min}.js" ), array( 'wp-color-picker' ), '2.1.3' );
}
/**
* Register or enqueue the jquery-ui-datetimepicker script.
*
* @since 2.2.7
*
* @param boolean $enqueue Whether or not to enqueue.
*
* @return void
*/
public static function register_datetimepicker( $enqueue = false ) {
$func = $enqueue ? 'wp_enqueue_script' : 'wp_register_script';
$func( 'jquery-ui-datetimepicker', CMB2_Utils::url( 'js/jquery-ui-timepicker-addon.min.js' ), array( 'jquery-ui-slider' ), '1.5.0' );
}
/**
* We need to register colorpicker on the front-end
*
* @since 2.0.7
*/
protected static function colorpicker_frontend() {
wp_register_script( 'iris', admin_url( 'js/iris.min.js' ), array( 'jquery-ui-draggable', 'jquery-ui-slider', 'jquery-touch-punch' ), CMB2_VERSION );
wp_register_script( 'wp-color-picker', admin_url( 'js/color-picker.min.js' ), array( 'iris' ), CMB2_VERSION );
wp_localize_script( 'wp-color-picker', 'wpColorPickerL10n', array(
'clear' => esc_html__( 'Clear', 'cmb2' ),
'defaultString' => esc_html__( 'Default', 'cmb2' ),
'pick' => esc_html__( 'Select Color', 'cmb2' ),
'current' => esc_html__( 'Current Color', 'cmb2' ),
) );
}
/**
* Localize the php variables for CMB2 JS
*
* @since 2.0.7
*
* @param mixed $debug Whether or not we are debugging.
*/
protected static function localize( $debug ) {
static $localized = false;
if ( $localized ) {
return;
}
$localized = true;
$l10n = array(
'fields' => self::$fields,
'ajax_nonce' => wp_create_nonce( 'ajax_nonce' ),
'ajaxurl' => admin_url( '/admin-ajax.php' ),
'script_debug' => $debug,
'up_arrow_class' => 'dashicons dashicons-arrow-up-alt2',
'down_arrow_class' => 'dashicons dashicons-arrow-down-alt2',
'user_can_richedit' => user_can_richedit(),
'defaults' => array(
'code_editor' => false,
'color_picker' => false,
'date_picker' => array(
'changeMonth' => true,
'changeYear' => true,
'dateFormat' => _x( 'mm/dd/yy', 'Valid formatDate string for jquery-ui datepicker', 'cmb2' ),
'dayNames' => explode( ',', esc_html__( 'Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday', 'cmb2' ) ),
'dayNamesMin' => explode( ',', esc_html__( 'Su, Mo, Tu, We, Th, Fr, Sa', 'cmb2' ) ),
'dayNamesShort' => explode( ',', esc_html__( 'Sun, Mon, Tue, Wed, Thu, Fri, Sat', 'cmb2' ) ),
'monthNames' => explode( ',', esc_html__( 'January, February, March, April, May, June, July, August, September, October, November, December', 'cmb2' ) ),
'monthNamesShort' => explode( ',', esc_html__( 'Jan, Feb, Mar, Apr, May, Jun, Jul, Aug, Sep, Oct, Nov, Dec', 'cmb2' ) ),
'nextText' => esc_html__( 'Next', 'cmb2' ),
'prevText' => esc_html__( 'Prev', 'cmb2' ),
'currentText' => esc_html__( 'Today', 'cmb2' ),
'closeText' => esc_html__( 'Done', 'cmb2' ),
'clearText' => esc_html__( 'Clear', 'cmb2' ),
),
'time_picker' => array(
'timeOnlyTitle' => esc_html__( 'Choose Time', 'cmb2' ),
'timeText' => esc_html__( 'Time', 'cmb2' ),
'hourText' => esc_html__( 'Hour', 'cmb2' ),
'minuteText' => esc_html__( 'Minute', 'cmb2' ),
'secondText' => esc_html__( 'Second', 'cmb2' ),
'currentText' => esc_html__( 'Now', 'cmb2' ),
'closeText' => esc_html__( 'Done', 'cmb2' ),
'timeFormat' => _x( 'hh:mm TT', 'Valid formatting string, as per http://trentrichardson.com/examples/timepicker/', 'cmb2' ),
'controlType' => 'select',
'stepMinute' => 5,
),
),
'strings' => array(
'upload_file' => esc_html__( 'Use this file', 'cmb2' ),
'upload_files' => esc_html__( 'Use these files', 'cmb2' ),
'remove_image' => esc_html__( 'Remove Image', 'cmb2' ),
'remove_file' => esc_html__( 'Remove', 'cmb2' ),
'file' => esc_html__( 'File:', 'cmb2' ),
'download' => esc_html__( 'Download', 'cmb2' ),
'check_toggle' => esc_html__( 'Select / Deselect All', 'cmb2' ),
),
);
if ( isset( self::$dependencies['code-editor'] ) && function_exists( 'wp_enqueue_code_editor' ) ) {
$l10n['defaults']['code_editor'] = wp_enqueue_code_editor( array(
'type' => 'text/html',
) );
}
wp_localize_script( self::$handle, self::$js_variable, apply_filters( 'cmb2_localized_data', $l10n ) );
}
}

View File

@ -0,0 +1,250 @@
<?php
/**
* CMB2 Utility classes for handling multi-dimensional array data for options
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
/**
* Retrieves an instance of CMB2_Option based on the option key
*
* @package CMB2
* @author CMB2 team
*/
class CMB2_Options {
/**
* Array of all CMB2_Option instances
*
* @var array
* @since 1.0.0
*/
protected static $option_sets = array();
public static function get( $option_key ) {
if ( empty( self::$option_sets ) || empty( self::$option_sets[ $option_key ] ) ) {
self::$option_sets[ $option_key ] = new CMB2_Option( $option_key );
}
return self::$option_sets[ $option_key ];
}
}
/**
* Handles getting/setting of values to an option array
* for a specific option key
*
* @package CMB2
* @author CMB2 team
*/
class CMB2_Option {
/**
* Options array
*
* @var array
*/
protected $options = array();
/**
* Current option key
*
* @var string
*/
protected $key = '';
/**
* Initiate option object
*
* @param string $option_key Option key where data will be saved.
* Leave empty for temporary data store.
* @since 2.0.0
*/
public function __construct( $option_key = '' ) {
$this->key = ! empty( $option_key ) ? $option_key : '';
}
/**
* Delete the option from the db
*
* @since 2.0.0
* @return mixed Delete success or failure
*/
public function delete_option() {
$deleted = $this->key ? delete_option( $this->key ) : true;
$this->options = $deleted ? array() : $this->options;
return $this->options;
}
/**
* Removes an option from an option array
*
* @since 1.0.1
* @param string $field_id Option array field key.
* @param bool $resave Whether or not to resave.
* @return array Modified options
*/
public function remove( $field_id, $resave = false ) {
$this->get_options();
if ( isset( $this->options[ $field_id ] ) ) {
unset( $this->options[ $field_id ] );
}
if ( $resave ) {
$this->set();
}
return $this->options;
}
/**
* Retrieves an option from an option array
*
* @since 1.0.1
* @param string $field_id Option array field key.
* @param mixed $default Fallback value for the option.
* @return array Requested field or default
*/
public function get( $field_id, $default = false ) {
$opts = $this->get_options();
if ( 'all' == $field_id ) {
return $opts;
} elseif ( array_key_exists( $field_id, $opts ) ) {
return false !== $opts[ $field_id ] ? $opts[ $field_id ] : $default;
}
return $default;
}
/**
* Updates Option data
*
* @since 1.0.1
* @param string $field_id Option array field key.
* @param mixed $value Value to update data with.
* @param bool $resave Whether to re-save the data.
* @param bool $single Whether data should not be an array.
* @return boolean Return status of update.
*/
public function update( $field_id, $value = '', $resave = false, $single = true ) {
$this->get_options();
if ( true !== $field_id ) {
if ( ! $single ) {
// If multiple, add to array.
$this->options[ $field_id ][] = $value;
} else {
$this->options[ $field_id ] = $value;
}
}
if ( $resave || true === $field_id ) {
return $this->set();
}
return true;
}
/**
* Saves the option array
* Needs to be run after finished using remove/update_option
*
* @uses apply_filters() Calls 'cmb2_override_option_save_{$this->key}' hook
* to allow overwriting the option value to be stored.
*
* @since 1.0.1
* @param array $options Optional options to override.
* @return bool Success/Failure
*/
public function set( $options = array() ) {
if ( ! empty( $options ) || empty( $options ) && empty( $this->key ) ) {
$this->options = $options;
}
$this->options = wp_unslash( $this->options ); // get rid of those evil magic quotes.
if ( empty( $this->key ) ) {
return false;
}
$test_save = apply_filters( "cmb2_override_option_save_{$this->key}", 'cmb2_no_override_option_save', $this->options, $this );
if ( 'cmb2_no_override_option_save' !== $test_save ) {
// If override, do not proceed to update the option, just return result.
return $test_save;
}
/**
* Whether to auto-load the option when WordPress starts up.
*
* The dynamic portion of the hook name, $this->key, refers to the option key.
*
* @since 2.4.0
*
* @param bool $autoload Whether to load the option when WordPress starts up.
* @param CMB2_Option $cmb_option This object.
*/
$autoload = apply_filters( "cmb2_should_autoload_{$this->key}", true, $this );
return update_option(
$this->key,
$this->options,
! $autoload || 'no' === $autoload ? false : true
);
}
/**
* Retrieve option value based on name of option.
*
* @uses apply_filters() Calls 'cmb2_override_option_get_{$this->key}' hook to allow
* overwriting the option value to be retrieved.
*
* @since 1.0.1
* @param mixed $default Optional. Default value to return if the option does not exist.
* @return mixed Value set for the option.
*/
public function get_options( $default = null ) {
if ( empty( $this->options ) && ! empty( $this->key ) ) {
$test_get = apply_filters( "cmb2_override_option_get_{$this->key}", 'cmb2_no_override_option_get', $default, $this );
if ( 'cmb2_no_override_option_get' !== $test_get ) {
$this->options = $test_get;
} else {
// If no override, get the option.
$this->options = get_option( $this->key, $default );
}
}
$this->options = (array) $this->options;
return $this->options;
}
/**
* Magic getter for our object.
*
* @since 2.6.0
*
* @param string $field Requested property.
* @throws Exception Throws an exception if the field is invalid.
* @return mixed
*/
public function __get( $field ) {
switch ( $field ) {
case 'options':
case 'key':
return $this->{$field};
default:
throw new Exception( sprintf( esc_html__( 'Invalid %1$s property: %2$s', 'cmb2' ), __CLASS__, $field ) );
}
}
}

View File

@ -0,0 +1,372 @@
<?php
/**
* Handles hooking CMB2 forms/metaboxes into the post/attachement/user screens
* and handles hooking in and saving those fields.
*
* @since 2.0.0
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Options_Hookup extends CMB2_Hookup {
/**
* The object type we are performing the hookup for
*
* @var string
* @since 2.0.9
*/
protected $object_type = 'options-page';
/**
* Options page key.
*
* @var string
* @since 2.2.5
*/
protected $option_key = '';
/**
* Constructor
*
* @since 2.0.0
* @param CMB2 $cmb The CMB2 object to hookup.
* @param string $option_key Option key to use.
*/
public function __construct( CMB2 $cmb, $option_key ) {
$this->cmb = $cmb;
$this->option_key = $option_key;
}
public function hooks() {
if ( empty( $this->option_key ) ) {
return;
}
if ( ! $this->cmb->prop( 'autoload', true ) ) {
// Disable option autoload if requested.
add_filter( "cmb2_should_autoload_{$this->option_key}", '__return_false' );
}
/**
* For WP < 4.7. Ensure the register_setting function exists.
*/
if ( ! CMB2_Utils::wp_at_least( '4.7' ) && ! function_exists( 'register_setting' ) ) {
require_once ABSPATH . 'wp-admin/includes/plugin.php';
}
// Register setting to cmb2 group.
register_setting( 'cmb2', $this->option_key );
// Handle saving the data.
add_action( 'admin_post_' . $this->option_key, array( $this, 'save_options' ) );
// Optionally network_admin_menu.
$hook = $this->cmb->prop( 'admin_menu_hook' );
// Hook in to add our menu.
add_action( $hook, array( $this, 'options_page_menu_hooks' ), $this->get_priority() );
// If in the network admin, need to use get/update_site_option.
if ( 'network_admin_menu' === $hook ) {
// Override CMB's getter.
add_filter( "cmb2_override_option_get_{$this->option_key}", array( $this, 'network_get_override' ), 10, 2 );
// Override CMB's setter.
add_filter( "cmb2_override_option_save_{$this->option_key}", array( $this, 'network_update_override' ), 10, 2 );
}
}
/**
* Hook up our admin menu item and admin page.
*
* @since 2.2.5
*
* @return void
*/
public function options_page_menu_hooks() {
$parent_slug = $this->cmb->prop( 'parent_slug' );
$title = $this->cmb->prop( 'title' );
$menu_title = $this->cmb->prop( 'menu_title', $title );
$capability = $this->cmb->prop( 'capability' );
$callback = array( $this, 'options_page_output' );
if ( $parent_slug ) {
$page_hook = add_submenu_page(
$parent_slug,
$title,
$menu_title,
$capability,
$this->option_key,
$callback
);
} else {
$page_hook = add_menu_page(
$title,
$menu_title,
$capability,
$this->option_key,
$callback,
$this->cmb->prop( 'icon_url' ),
$this->cmb->prop( 'position' )
);
}
if ( $this->cmb->prop( 'cmb_styles' ) ) {
// Include CMB CSS in the head to avoid FOUC.
add_action( "admin_print_styles-{$page_hook}", array( 'CMB2_Hookup', 'enqueue_cmb_css' ) );
}
$this->maybe_register_message();
}
/**
* If there is a message callback, let it determine how to register the message,
* else add a settings message if on this settings page.
*
* @since 2.2.6
*
* @return void
*/
public function maybe_register_message() {
$is_options_page = self::is_page( $this->option_key );
$should_notify = ! $this->cmb->prop( 'disable_settings_errors' ) && isset( $_GET['settings-updated'] ) && $is_options_page;
$is_updated = $should_notify && 'true' === $_GET['settings-updated'];
$setting = "{$this->option_key}-notices";
$code = '';
$message = __( 'Nothing to update.', 'cmb2' );
$type = 'notice-warning';
if ( $is_updated ) {
$message = __( 'Settings updated.', 'cmb2' );
$type = 'updated';
}
// Check if parameter has registered a callback.
if ( $cb = $this->cmb->maybe_callback( 'message_cb' ) ) {
/**
* The 'message_cb' callback will receive the following parameters.
* Unless there are other reasons for notifications, the callback should only
* `add_settings_error()` if `$args['should_notify']` is truthy.
*
* @param CMB2 $cmb The CMB2 object.
* @param array $args {
* An array of message arguments
*
* @type bool $is_options_page Whether current page is this options page.
* @type bool $should_notify Whether options were saved and we should be notified.
* @type bool $is_updated Whether options were updated with save (or stayed the same).
* @type string $setting For add_settings_error(), Slug title of the setting to which
* this error applies.
* @type string $code For add_settings_error(), Slug-name to identify the error.
* Used as part of 'id' attribute in HTML output.
* @type string $message For add_settings_error(), The formatted message text to display
* to the user (will be shown inside styled `<div>` and `<p>` tags).
* Will be 'Settings updated.' if $is_updated is true, else 'Nothing to update.'
* @type string $type For add_settings_error(), Message type, controls HTML class.
* Accepts 'error', 'updated', '', 'notice-warning', etc.
* Will be 'updated' if $is_updated is true, else 'notice-warning'.
* }
*/
$args = compact( 'is_options_page', 'should_notify', 'is_updated', 'setting', 'code', 'message', 'type' );
$this->cmb->do_callback( $cb, $args );
} elseif ( $should_notify ) {
add_settings_error( $setting, $code, $message, $type );
}
}
/**
* Display options-page output. To override, set 'display_cb' box property.
*
* @since 2.2.5
*/
public function options_page_output() {
$this->maybe_output_settings_notices();
$callback = $this->cmb->prop( 'display_cb' );
if ( is_callable( $callback ) ) {
return call_user_func( $callback, $this );
}
?>
<div class="wrap cmb2-options-page option-<?php echo esc_attr( sanitize_html_class( $this->option_key ) ); ?>">
<?php if ( $this->cmb->prop( 'title' ) ) : ?>
<h2><?php echo wp_kses_post( $this->cmb->prop( 'title' ) ); ?></h2>
<?php endif; ?>
<?php $this->options_page_tab_nav_output(); ?>
<form class="cmb-form" action="<?php echo esc_url( admin_url( 'admin-post.php' ) ); ?>" method="POST" id="<?php echo $this->cmb->cmb_id; ?>" enctype="multipart/form-data" encoding="multipart/form-data">
<input type="hidden" name="action" value="<?php echo esc_attr( $this->option_key ); ?>">
<?php $this->options_page_metabox(); ?>
<?php submit_button( esc_attr( $this->cmb->prop( 'save_button' ) ), 'primary', 'submit-cmb' ); ?>
</form>
</div>
<?php
}
/**
* Display options-page Tab Navigation output.
*
* @since 2.9.0
*/
public function options_page_tab_nav_output() {
$tabs = $this->get_tab_group_tabs();
if ( empty( $tabs ) ) {
return;
}
?>
<h2 class="nav-tab-wrapper">
<?php foreach ( $tabs as $option_key => $tab_title ) : ?>
<a class="nav-tab<?php if ( self::is_page( $option_key ) ) : ?> nav-tab-active<?php endif; ?>" href="<?php menu_page_url( $option_key ); ?>"><?php echo wp_kses_post( $tab_title ); ?></a>
<?php endforeach; ?>
</h2>
<?php
}
/**
* Outputs the settings notices if a) not a sub-page of 'options-general.php'
* (because settings_errors() already called in wp-admin/options-head.php),
* and b) the 'disable_settings_errors' prop is not set or truthy.
*
* @since 2.2.5
* @return void
*/
public function maybe_output_settings_notices() {
global $parent_file;
// The settings sub-pages will already have settings_errors() called in wp-admin/options-head.php.
if ( 'options-general.php' !== $parent_file ) {
settings_errors( "{$this->option_key}-notices" );
}
}
/**
* Gets navigation tabs array for CMB2 options pages which share the
* same tab_group property.
*
* @since 2.4.0
* @return array Array of tab information ($option_key => $tab_title)
*/
public function get_tab_group_tabs() {
$tab_group = $this->cmb->prop( 'tab_group' );
$tabs = array();
if ( $tab_group ) {
$boxes = CMB2_Boxes::get_by( 'tab_group', $tab_group );
foreach ( $boxes as $cmb_id => $cmb ) {
$option_key = $cmb->options_page_keys();
// Must have an option key, must be an options page box.
if ( ! isset( $option_key[0] ) || 'options-page' !== $cmb->mb_object_type() ) {
continue;
}
$tabs[ $option_key[0] ] = $cmb->prop( 'tab_title', $cmb->prop( 'title' ) );
}
}
return apply_filters( 'cmb2_tab_group_tabs', $tabs, $tab_group );
}
/**
* Display metaboxes for an options-page object.
*
* @since 2.2.5
*/
public function options_page_metabox() {
$this->show_form_for_type( 'options-page' );
}
/**
* Save data from options page, then redirects back.
*
* @since 2.2.5
* @return void
*/
public function save_options() {
$url = wp_get_referer();
if ( ! $url ) {
$url = admin_url();
}
if (
$this->can_save( 'options-page' )
// check params.
&& isset( $_POST['submit-cmb'], $_POST['action'] )
&& $this->option_key === $_POST['action']
) {
$updated = $this->cmb
->save_fields( $this->option_key, $this->cmb->object_type(), $_POST )
->was_updated(); // Will be false if no values were changed/updated.
$url = add_query_arg( 'settings-updated', $updated ? 'true' : 'false', $url );
}
wp_safe_redirect( esc_url_raw( $url ), 303 /* WP_Http::SEE_OTHER */ );
exit;
}
/**
* Replaces get_option with get_site_option.
*
* @since 2.2.5
*
* @param mixed $test Not used.
* @param mixed $default Default value to use.
* @return mixed Value set for the network option.
*/
public function network_get_override( $test, $default = false ) {
return get_site_option( $this->option_key, $default );
}
/**
* Replaces update_option with update_site_option.
*
* @since 2.2.5
*
* @param mixed $test Not used.
* @param mixed $option_value Value to use.
* @return bool Success/Failure
*/
public function network_update_override( $test, $option_value ) {
return update_site_option( $this->option_key, $option_value );
}
/**
* Determines if given page slug matches the 'page' GET query variable.
*
* @since 2.4.0
*
* @param string $page Page slug.
* @return boolean
*/
public static function is_page( $page ) {
return isset( $_GET['page'] ) && $page === $_GET['page'];
}
/**
* Magic getter for our object.
*
* @param string $field Property to retrieve.
*
* @throws Exception Throws an exception if the field is invalid.
* @return mixed
*/
public function __get( $field ) {
switch ( $field ) {
case 'object_type':
case 'option_key':
case 'cmb':
return $this->{$field};
default:
throw new Exception( sprintf( esc_html__( 'Invalid %1$s property: %2$s', 'cmb2' ), __CLASS__, $field ) );
}
}
}

View File

@ -0,0 +1,665 @@
<?php
/**
* CMB2 field sanitization
*
* @since 0.0.4
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*
* @method string _id()
*/
class CMB2_Sanitize {
/**
* A CMB field object
*
* @var CMB2_Field object
*/
public $field;
/**
* Field's value
*
* @var mixed
*/
public $value;
/**
* Setup our class vars
*
* @since 1.1.0
* @param CMB2_Field $field A CMB2 field object.
* @param mixed $value Field value.
*/
public function __construct( CMB2_Field $field, $value ) {
$this->field = $field;
$this->value = $value;
}
/**
* Catchall method if field's 'sanitization_cb' is NOT defined,
* or field type does not have a corresponding validation method.
*
* @since 1.0.0
*
* @param string $name Non-existent method name.
* @param array $arguments All arguments passed to the method.
* @return mixed
*/
public function __call( $name, $arguments ) {
return $this->default_sanitization();
}
/**
* Default fallback sanitization method. Applies filters.
*
* @since 1.0.2
*/
public function default_sanitization() {
$field_type = $this->field->type();
/**
* This exists for back-compatibility, but validation
* is not what happens here.
*
* @deprecated See documentation for "cmb2_sanitize_{$field_type}".
*/
if ( function_exists( 'apply_filters_deprecated' ) ) {
$override_value = apply_filters_deprecated( "cmb2_validate_{$field_type}", array( null, $this->value, $this->field->object_id, $this->field->args(), $this ), '2.0.0', "cmb2_sanitize_{$field_type}" );
} else {
$override_value = apply_filters( "cmb2_validate_{$field_type}", null, $this->value, $this->field->object_id, $this->field->args(), $this );
}
if ( null !== $override_value ) {
return $override_value;
}
$sanitized_value = '';
switch ( $field_type ) {
case 'wysiwyg':
case 'textarea_small':
case 'oembed':
$sanitized_value = $this->textarea();
break;
case 'taxonomy_select':
case 'taxonomy_select_hierarchical':
case 'taxonomy_radio':
case 'taxonomy_radio_inline':
case 'taxonomy_radio_hierarchical':
case 'taxonomy_multicheck':
case 'taxonomy_multicheck_hierarchical':
case 'taxonomy_multicheck_inline':
$sanitized_value = $this->taxonomy();
break;
case 'multicheck':
case 'multicheck_inline':
case 'file_list':
case 'group':
// no filtering
$sanitized_value = $this->value;
break;
default:
// Handle repeatable fields array
// We'll fallback to 'sanitize_text_field'
$sanitized_value = $this->_default_sanitization();
break;
}
return $this->_is_empty_array( $sanitized_value ) ? '' : $sanitized_value;
}
/**
* Default sanitization method, sanitize_text_field. Checks if value is array.
*
* @since 2.2.4
* @return mixed Sanitized value.
*/
protected function _default_sanitization() {
// Handle repeatable fields array.
return is_array( $this->value ) ? array_map( 'sanitize_text_field', $this->value ) : sanitize_text_field( $this->value );
}
/**
* Sets the object terms to the object (if not options-page) and optionally returns the sanitized term values.
*
* @since 2.2.4
* @return mixed Blank value, or sanitized term values if "cmb2_return_taxonomy_values_{$cmb_id}" is true.
*/
public function taxonomy() {
$sanitized_value = '';
if ( ! $this->field->args( 'taxonomy' ) ) {
CMB2_Utils::log_if_debug( __METHOD__, __LINE__, "{$this->field->type()} {$this->field->_id( '', false )} is missing the 'taxonomy' parameter." );
} else {
if ( in_array( $this->field->object_type, array( 'options-page', 'term' ), true ) ) {
$return_values = true;
} else {
wp_set_object_terms( $this->field->object_id, $this->value, $this->field->args( 'taxonomy' ) );
$return_values = false;
}
$cmb_id = $this->field->cmb_id;
/**
* Filter whether 'taxonomy_*' fields should return their value when being sanitized.
*
* By default, these fields do not return a value as we do not want them stored to meta
* (as they are stored as terms). This allows overriding that and is used by CMB2::get_sanitized_values().
*
* The dynamic portion of the hook, $cmb_id, refers to the this field's CMB2 box id.
*
* @since 2.2.4
*
* @param bool $return_values By default, this is only true for 'options-page' boxes. To enable:
* `add_filter( "cmb2_return_taxonomy_values_{$cmb_id}", '__return_true' );`
* @param CMB2_Sanitize $sanitizer This object.
*/
if ( apply_filters( "cmb2_return_taxonomy_values_{$cmb_id}", $return_values, $this ) ) {
$sanitized_value = $this->_default_sanitization();
}
}
return $sanitized_value;
}
/**
* Simple checkbox validation
*
* @since 1.0.1
* @return string|false 'on' or false
*/
public function checkbox() {
return $this->value === 'on' ? 'on' : false;
}
/**
* Validate url in a meta value.
*
* @since 1.0.1
* @return string Empty string or escaped url
*/
public function text_url() {
$protocols = $this->field->args( 'protocols' );
$default = $this->field->get_default();
// for repeatable.
if ( is_array( $this->value ) ) {
foreach ( $this->value as $key => $val ) {
$this->value[ $key ] = self::sanitize_and_secure_url( $val, $protocols, $default );
}
} else {
$this->value = self::sanitize_and_secure_url( $this->value, $protocols, $default );
}
return $this->value;
}
public function colorpicker() {
// for repeatable.
if ( is_array( $this->value ) ) {
$check = $this->value;
$this->value = array();
foreach ( $check as $key => $val ) {
if ( $val && '#' != $val ) {
$this->value[ $key ] = esc_attr( $val );
}
}
} else {
$this->value = ! $this->value || '#' == $this->value ? '' : esc_attr( $this->value );
}
return $this->value;
}
/**
* Validate email in a meta value
*
* @since 1.0.1
* @return string Empty string or sanitized email
*/
public function text_email() {
// for repeatable.
if ( is_array( $this->value ) ) {
foreach ( $this->value as $key => $val ) {
$val = trim( $val );
$this->value[ $key ] = is_email( $val ) ? $val : '';
}
} else {
$this->value = trim( $this->value );
$this->value = is_email( $this->value ) ? $this->value : '';
}
return $this->value;
}
/**
* Validate money in a meta value
*
* @since 1.0.1
* @return string Empty string or sanitized money value
*/
public function text_money() {
if ( ! $this->value ) {
return '';
}
global $wp_locale;
$search = array( $wp_locale->number_format['thousands_sep'], $wp_locale->number_format['decimal_point'] );
$replace = array( '', '.' );
// Strip slashes. Example: 2\'180.00.
// See https://github.com/CMB2/CMB2/issues/1014.
$this->value = wp_unslash( $this->value );
// for repeatable.
if ( is_array( $this->value ) ) {
foreach ( $this->value as $key => $val ) {
if ( $val ) {
$this->value[ $key ] = number_format_i18n( (float) str_ireplace( $search, $replace, $val ), 2 );
}
}
} else {
$this->value = number_format_i18n( (float) str_ireplace( $search, $replace, $this->value ), 2 );
}
return $this->value;
}
/**
* Converts text date to timestamp
*
* @since 1.0.2
* @return string Timestring
*/
public function text_date_timestamp() {
// date_create_from_format if there is a slash in the value.
$this->value = wp_unslash( $this->value );
return is_array( $this->value )
? array_map( array( $this->field, 'get_timestamp_from_value' ), $this->value )
: $this->field->get_timestamp_from_value( $this->value );
}
/**
* Datetime to timestamp
*
* @since 1.0.1
*
* @param bool $repeat Whether or not to repeat.
* @return string|array Timestring
*/
public function text_datetime_timestamp( $repeat = false ) {
// date_create_from_format if there is a slash in the value.
$this->value = wp_unslash( $this->value );
if ( $this->is_empty_value() ) {
return '';
}
$repeat_value = $this->_check_repeat( __FUNCTION__, $repeat );
if ( false !== $repeat_value ) {
return $repeat_value;
}
// Account for timestamp values passed through REST API.
if ( $this->is_valid_date_value() ) {
$this->value = CMB2_Utils::make_valid_time_stamp( $this->value );
} elseif ( isset( $this->value['date'], $this->value['time'] ) ) {
$this->value = $this->field->get_timestamp_from_value( $this->value['date'] . ' ' . $this->value['time'] );
}
if ( $tz_offset = $this->field->field_timezone_offset() ) {
$this->value += (int) $tz_offset;
}
return $this->value;
}
/**
* Datetime to timestamp with timezone
*
* @since 1.0.1
*
* @param bool $repeat Whether or not to repeat.
* @return string Timestring
*/
public function text_datetime_timestamp_timezone( $repeat = false ) {
static $utc_values = array();
if ( $this->is_empty_value() ) {
return '';
}
// date_create_from_format if there is a slash in the value.
$this->value = wp_unslash( $this->value );
$utc_key = $this->field->_id( '', false ) . '_utc';
$repeat_value = $this->_check_repeat( __FUNCTION__, $repeat );
if ( false !== $repeat_value ) {
if ( ! empty( $utc_values[ $utc_key ] ) ) {
$this->_save_utc_value( $utc_key, $utc_values[ $utc_key ] );
unset( $utc_values[ $utc_key ] );
}
return $repeat_value;
}
$tzstring = null;
if ( is_array( $this->value ) && array_key_exists( 'timezone', $this->value ) ) {
$tzstring = $this->value['timezone'];
}
if ( empty( $tzstring ) ) {
$tzstring = CMB2_Utils::timezone_string();
}
$offset = CMB2_Utils::timezone_offset( $tzstring );
if ( 'UTC' === substr( $tzstring, 0, 3 ) ) {
$tzstring = timezone_name_from_abbr( '', $offset, 0 );
/**
* The timezone_name_from_abbr() returns false if not found based on offset.
* Since there are currently some invalid timezones in wp_timezone_dropdown(),
* fallback to an offset of 0 (UTC+0)
* https://core.trac.wordpress.org/ticket/29205
*/
$tzstring = false !== $tzstring ? $tzstring : timezone_name_from_abbr( '', 0, 0 );
}
$full_format = $this->field->args['date_format'] . ' ' . $this->field->args['time_format'];
try {
$datetime = null;
if ( is_array( $this->value ) ) {
$full_date = $this->value['date'] . ' ' . $this->value['time'];
$datetime = date_create_from_format( $full_format, $full_date );
} elseif ( $this->is_valid_date_value() ) {
$timestamp = CMB2_Utils::make_valid_time_stamp( $this->value );
if ( $timestamp ) {
$datetime = new DateTime();
$datetime->setTimestamp( $timestamp );
}
}
if ( ! is_object( $datetime ) ) {
$this->value = $utc_stamp = '';
} else {
$datetime->setTimezone( new DateTimeZone( $tzstring ) );
$utc_stamp = date_timestamp_get( $datetime ) - $offset;
$this->value = serialize( $datetime );
}
if ( $this->field->group ) {
$this->value = array(
'supporting_field_value' => $utc_stamp,
'supporting_field_id' => $utc_key,
'value' => $this->value,
);
} else {
// Save the utc timestamp supporting field.
if ( $repeat ) {
$utc_values[ $utc_key ][] = $utc_stamp;
} else {
$this->_save_utc_value( $utc_key, $utc_stamp );
}
}
} catch ( Exception $e ) {
$this->value = '';
CMB2_Utils::log_if_debug( __METHOD__, __LINE__, $e->getMessage() );
}
return $this->value;
}
/**
* Sanitize textareas and wysiwyg fields
*
* @since 1.0.1
* @return string Sanitized data
*/
public function textarea() {
return is_array( $this->value ) ? array_map( 'wp_kses_post', $this->value ) : wp_kses_post( $this->value );
}
/**
* Sanitize code textareas
*
* @since 1.0.2
*
* @param bool $repeat Whether or not to repeat.
* @return string Sanitized data
*/
public function textarea_code( $repeat = false ) {
$repeat_value = $this->_check_repeat( __FUNCTION__, $repeat );
if ( false !== $repeat_value ) {
return $repeat_value;
}
return htmlspecialchars_decode( stripslashes( $this->value ) );
}
/**
* Handles saving of attachment post ID and sanitizing file url
*
* @since 1.1.0
* @return string Sanitized url
*/
public function file() {
$file_id_key = $this->field->_id( '', false ) . '_id';
if ( $this->field->group ) {
// Return an array with url/id if saving a group field.
$this->value = $this->_get_group_file_value_array( $file_id_key );
} else {
$this->_save_file_id_value( $file_id_key );
$this->text_url();
}
return $this->value;
}
/**
* Gets the values for the `file` field type from the data being saved.
*
* @since 2.2.0
*
* @param mixed $id_key ID key to use.
* @return array
*/
public function _get_group_file_value_array( $id_key ) {
$alldata = $this->field->group->data_to_save;
$base_id = $this->field->group->_id( '', false );
$i = $this->field->group->index;
// Check group $alldata data.
$id_val = isset( $alldata[ $base_id ][ $i ][ $id_key ] )
? absint( $alldata[ $base_id ][ $i ][ $id_key ] )
: '';
// We don't want to save 0 to the DB for file fields.
if ( 0 === $id_val ) {
$id_val = '';
}
return array(
'value' => $this->text_url(),
'supporting_field_value' => $id_val,
'supporting_field_id' => $id_key,
);
}
/**
* Peforms saving of `file` attachement's ID
*
* @since 1.1.0
*
* @param mixed $file_id_key ID key to use.
* @return mixed
*/
public function _save_file_id_value( $file_id_key ) {
$id_field = $this->_new_supporting_field( $file_id_key );
// Check standard data_to_save data.
$id_val = isset( $this->field->data_to_save[ $file_id_key ] )
? $this->field->data_to_save[ $file_id_key ]
: null;
// If there is no ID saved yet, try to get it from the url.
if ( $this->value && ! $id_val ) {
$id_val = CMB2_Utils::image_id_from_url( $this->value );
// If there is an ID but user emptied the input value, remove the ID.
} elseif ( ! $this->value && $id_val ) {
$id_val = null;
}
return $id_field->save_field( $id_val );
}
/**
* Peforms saving of `text_datetime_timestamp_timezone` utc timestamp
*
* @since 2.2.0
*
* @param mixed $utc_key UTC key.
* @param mixed $utc_stamp UTC timestamp.
* @return mixed
*/
public function _save_utc_value( $utc_key, $utc_stamp ) {
return $this->_new_supporting_field( $utc_key )->save_field( $utc_stamp );
}
/**
* Returns a new, supporting, CMB2_Field object based on a new field id.
*
* @since 2.2.0
*
* @param mixed $new_field_id New field ID.
* @return CMB2_Field
*/
public function _new_supporting_field( $new_field_id ) {
return $this->field->get_field_clone( array(
'id' => $new_field_id,
'sanitization_cb' => false,
) );
}
/**
* If repeating, loop through and re-apply sanitization method
*
* @since 1.1.0
* @param string $method Class method.
* @param bool $repeat Whether repeating or not.
* @return mixed Sanitized value
*/
public function _check_repeat( $method, $repeat ) {
if ( $repeat || ! $this->field->args( 'repeatable' ) ) {
return false;
}
$values_array = $this->value;
$new_value = array();
foreach ( $values_array as $iterator => $this->value ) {
if ( $this->value ) {
$val = $this->$method( true );
if ( ! empty( $val ) ) {
$new_value[] = $val;
}
}
}
$this->value = $new_value;
return empty( $this->value ) ? null : $this->value;
}
/**
* Determine if passed value is an empty array
*
* @since 2.0.6
* @param mixed $to_check Value to check.
* @return boolean Whether value is an array that's empty
*/
public function _is_empty_array( $to_check ) {
if ( is_array( $to_check ) ) {
$cleaned_up = array_filter( $to_check );
return empty( $cleaned_up );
}
return false;
}
/**
* Sanitize a URL. Make the default scheme HTTPS.
*
* @since 2.10.0
* @param string $value Unescaped URL.
* @param array $protocols Allowed protocols for URL.
* @param string $default Default value if no URL found.
* @return string escaped URL.
*/
public static function sanitize_and_secure_url( $url, $protocols = null, $default = null ) {
if ( empty( $url ) ) {
return $default;
}
$orig_scheme = parse_url( $url, PHP_URL_SCHEME );
$url = esc_url_raw( $url, $protocols );
// If original url has no scheme...
if ( null === $orig_scheme ) {
// Let's make sure the added scheme is https.
$url = set_url_scheme( $url, 'https' );
}
return $url;
}
/**
* Check if the current field's value is empty.
*
* @since 2.9.1
*
* @return boolean Wether value is empty.
*/
public function is_empty_value() {
if ( empty( $this->value ) ) {
return true;
}
if ( is_array( $this->value ) ) {
$test = array_filter( $this->value );
if ( empty( $test ) ) {
return true;
}
}
return false;
}
/**
* Check if the current field's value is a valid date value.
*
* @since 2.9.1
*
* @return boolean Wether value is a valid date value.
*/
public function is_valid_date_value() {
return is_scalar( $this->value ) && CMB2_Utils::is_valid_date( $this->value );
}
}

View File

@ -0,0 +1,179 @@
<?php
/**
* Show On Filters
* Use the 'cmb2_show_on' filter to further refine the conditions
* under which a metabox is displayed.
* Below you can limit it by ID and page template
*
* All methods in this class are automatically filtered
*
* @since 1.0.0
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Show_Filters {
/**
* Get Show_on key. backwards compatible w/ 'key' indexes
*
* @since 2.0.0
*
* @param array $meta_box_args Metabox config array.
*
* @return mixed show_on key or false
*/
private static function get_show_on_key( $meta_box_args ) {
$show_on = isset( $meta_box_args['show_on'] ) ? (array) $meta_box_args['show_on'] : false;
if ( $show_on && is_array( $show_on ) ) {
if ( array_key_exists( 'key', $show_on ) ) {
return $show_on['key'];
}
$keys = array_keys( $show_on );
return $keys[0];
}
return false;
}
/**
* Get Show_on value. backwards compatible w/ 'value' indexes
*
* @since 2.0.0
*
* @param array $meta_box_args Metabox config array.
*
* @return mixed show_on value or false
*/
private static function get_show_on_value( $meta_box_args ) {
$show_on = isset( $meta_box_args['show_on'] ) ? (array) $meta_box_args['show_on'] : false;
if ( $show_on && is_array( $show_on ) ) {
if ( array_key_exists( 'value', $show_on ) ) {
return $show_on['value'];
}
$keys = array_keys( $show_on );
return $show_on[ $keys[0] ];
}
return array();
}
/**
* Add metaboxes for an specific ID
*
* @since 1.0.0
* @param bool $display To display or not.
* @param array $meta_box_args Metabox config array.
* @param CMB2 $cmb The CMB2 instance.
* @return bool Whether to display this metabox on the current page.
*/
public static function check_id( $display, $meta_box_args, $cmb ) {
$key = self::get_show_on_key( $meta_box_args );
if ( ! $key || 'id' !== $key ) {
return $display;
}
$object_id = is_admin() ? $cmb->object_id() : get_the_ID();
if ( ! $object_id ) {
return false;
}
// If current page id is in the included array, display the metabox.
return in_array( $object_id, (array) self::get_show_on_value( $meta_box_args ) );
}
/**
* Add metaboxes for an specific Page Template
*
* @since 1.0.0
* @param bool $display To display or not.
* @param array $meta_box_args Metabox config array.
* @param CMB2 $cmb CMB2 object.
* @return bool Whether to display this metabox on the current page.
*/
public static function check_page_template( $display, $meta_box_args, $cmb ) {
$key = self::get_show_on_key( $meta_box_args );
if ( ! $key || 'page-template' !== $key ) {
return $display;
}
$object_id = $cmb->object_id();
if ( ! $object_id || 'post' !== $cmb->object_type() ) {
return false;
}
// Get current template.
$current_template = get_post_meta( $object_id, '_wp_page_template', true );
// See if there's a match.
if ( $current_template && in_array( $current_template, (array) self::get_show_on_value( $meta_box_args ) ) ) {
return true;
}
return false;
}
/**
* Only show options-page metaboxes on their options page (but only enforce on the admin side)
*
* @since 1.0.0
* @param bool $display To display or not.
* @param array $meta_box_args Metabox config array.
* @return bool Whether to display this metabox on the current page.
*/
public static function check_admin_page( $display, $meta_box_args ) {
$key = self::get_show_on_key( $meta_box_args );
// check if this is a 'options-page' metabox.
if ( ! $key || 'options-page' !== $key ) {
return $display;
}
// Enforce 'show_on' filter in the admin.
if ( is_admin() ) {
// If there is no 'page' query var, our filter isn't applicable.
if ( ! isset( $_GET['page'] ) ) {
return $display;
}
$show_on = self::get_show_on_value( $meta_box_args );
if ( empty( $show_on ) ) {
return false;
}
if ( is_array( $show_on ) ) {
foreach ( $show_on as $page ) {
if ( $_GET['page'] == $page ) {
return true;
}
}
} else {
if ( $_GET['page'] == $show_on ) {
return true;
}
}
return false;
}
// Allow options-page metaboxes to be displayed anywhere on the front-end.
return true;
}
}

View File

@ -0,0 +1,675 @@
<?php
/**
* CMB field type objects
*
* @since 1.0.0
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Types {
/**
* An iterator value for repeatable fields
*
* @var integer
* @since 1.0.0
*/
public $iterator = 0;
/**
* Current CMB2_Field field object
*
* @var CMB2_Field object
* @since 1.0.0
*/
public $field;
/**
* Current CMB2_Type_Base object
*
* @var CMB2_Type_Base object
* @since 2.2.2
*/
public $type = null;
public function __construct( CMB2_Field $field ) {
$this->field = $field;
}
/**
* Default fallback. Allows rendering fields via "cmb2_render_$fieldtype" hook
*
* @since 1.0.0
* @param string $fieldtype Non-existent field type name
* @param array $arguments All arguments passed to the method
*/
public function __call( $fieldtype, $arguments ) {
// Check for methods to be proxied to the CMB2_Type_Base object.
if ( $exists = $this->maybe_proxy_method( $fieldtype, $arguments ) ) {
return $exists['value'];
}
// Check for custom field type class.
if ( $object = $this->maybe_custom_field_object( $fieldtype, $arguments ) ) {
return $object->render();
}
/**
* Pass non-existent field types through an action.
*
* The dynamic portion of the hook name, $fieldtype, refers to the field type.
*
* @param array $field The passed in `CMB2_Field` object
* @param mixed $escaped_value The value of this field escaped.
* It defaults to `sanitize_text_field`.
* If you need the unescaped value, you can access it
* via `$field->value()`
* @param int $object_id The ID of the current object
* @param string $object_type The type of object you are working with.
* Most commonly, `post` (this applies to all post-types),
* but could also be `comment`, `user` or `options-page`.
* @param object $field_type_object This `CMB2_Types` object
*/
do_action( "cmb2_render_{$fieldtype}", $this->field, $this->field->escaped_value(), $this->field->object_id, $this->field->object_type, $this );
}
/**
* Render a field (and handle repeatable)
*
* @since 1.1.0
*/
public function render() {
if ( $this->field->args( 'repeatable' ) ) {
$this->render_repeatable_field();
} else {
$this->_render();
}
}
/**
* Render a field type
*
* @since 1.1.0
*/
protected function _render() {
$this->field->peform_param_callback( 'before_field' );
echo $this->{$this->field->type()}();
$this->field->peform_param_callback( 'after_field' );
}
/**
* Proxies the method call to the CMB2_Type_Base object, if it exists, otherwise returns a default fallback value.
*
* @since 2.2.2
*
* @param string $method Method to call on the CMB2_Type_Base object.
* @param mixed $default Default fallback value if method is not found.
* @param array $args Optional arguments to pass to proxy method.
*
* @return mixed Results from called method.
*/
protected function proxy_method( $method, $default, $args = array() ) {
if ( ! is_object( $this->type ) ) {
$this->guess_type_object( $method );
}
if ( is_object( $this->type ) && method_exists( $this->type, $method ) ) {
return empty( $args )
? $this->type->$method()
: call_user_func_array( array( $this->type, $method ), $args );
}
return $default;
}
/**
* If no CMB2_Types::$type object is initiated when a proxy method is called, it means
* it's a custom field type (which SHOULD be instantiating a Type), but let's try and
* guess the type object for them and instantiate it.
*
* @since 2.2.3
*
* @param string $method Method attempting to be called on the CMB2_Type_Base object.
* @return bool
*/
protected function guess_type_object( $method ) {
$fieldtype = $this->field->type();
// Try to "guess" the Type object based on the method requested.
switch ( $method ) {
case 'select_option':
case 'list_input':
case 'list_input_checkbox':
case 'concat_items':
$this->get_new_render_type( $fieldtype, 'CMB2_Type_Select' );
break;
case 'is_valid_img_ext':
case 'img_status_output':
case 'file_status_output':
$this->get_new_render_type( $fieldtype, 'CMB2_Type_File_Base' );
break;
case 'parse_picker_options':
$this->get_new_render_type( $fieldtype, 'CMB2_Type_Text_Date' );
break;
case 'get_object_terms':
case 'get_terms':
$this->get_new_render_type( $fieldtype, 'CMB2_Type_Taxonomy_Multicheck' );
break;
case 'date_args':
case 'time_args':
$this->get_new_render_type( $fieldtype, 'CMB2_Type_Text_Datetime_Timestamp' );
break;
case 'parse_args':
$this->get_new_render_type( $fieldtype, 'CMB2_Type_Text' );
break;
}
return null !== $this->type;
}
/**
* Check for methods to be proxied to the CMB2_Type_Base object.
*
* @since 2.2.4
* @param string $method The possible method to proxy.
* @param array $arguments All arguments passed to the method.
* @return bool|array False if not proxied, else array with 'value' key being the return of the method.
*/
public function maybe_proxy_method( $method, $arguments ) {
$exists = false;
$proxied = array(
'get_object_terms' => array(),
'is_valid_img_ext' => false,
'parse_args' => array(),
'concat_items' => '',
'select_option' => '',
'list_input' => '',
'list_input_checkbox' => '',
'img_status_output' => '',
'file_status_output' => '',
'parse_picker_options' => array(),
);
if ( isset( $proxied[ $method ] ) ) {
$exists = array(
// Ok, proxy the method call to the CMB2_Type_Base object.
'value' => $this->proxy_method( $method, $proxied[ $method ], $arguments ),
);
}
return $exists;
}
/**
* Checks for a custom field CMB2_Type_Base class to use for rendering.
*
* @since 2.2.4
*
* @param string $fieldtype Non-existent field type name.
* @param array $args Optional field arguments.
*
* @return bool|CMB2_Type_Base Type object if custom field is an object, false if field was added with
* `cmb2_render_{$field_type}` action.
* @throws Exception if custom field type class does not extend CMB2_Type_Base.
*/
public function maybe_custom_field_object( $fieldtype, $args = array() ) {
if ( $render_class_name = $this->get_render_type_class( $fieldtype ) ) {
$this->type = new $render_class_name( $this, $args );
if ( ! ( $this->type instanceof CMB2_Type_Base ) ) {
throw new Exception( __( 'Custom CMB2 field type classes must extend CMB2_Type_Base.', 'cmb2' ) );
}
return $this->type;
}
return false;
}
/**
* Gets the render type CMB2_Type_Base object to use for rendering the field.
*
* @since 2.2.4
* @param string $fieldtype The type of field being rendered.
* @param string $render_class_name The default field type class to use. Defaults to null.
* @param array $args Optional arguments to pass to type class.
* @param mixed $additional Optional additional argument to pass to type class.
* @return CMB2_Type_Base Type object.
*/
public function get_new_render_type( $fieldtype, $render_class_name = null, $args = array(), $additional = '' ) {
$render_class_name = $this->get_render_type_class( $fieldtype, $render_class_name );
$this->type = new $render_class_name( $this, $args, $additional );
return $this->type;
}
/**
* Checks for the render type class to use for rendering the field.
*
* @since 2.2.4
* @param string $fieldtype The type of field being rendered.
* @param string $render_class_name The default field type class to use. Defaults to null.
* @return string The field type class to use.
*/
public function get_render_type_class( $fieldtype, $render_class_name = null ) {
$render_class_name = $this->field->args( 'render_class' ) ? $this->field->args( 'render_class' ) : $render_class_name;
if ( has_action( "cmb2_render_class_{$fieldtype}" ) ) {
/**
* Filters the custom field type class used for rendering the field. Class is required to extend CMB2_Type_Base.
*
* The dynamic portion of the hook name, $fieldtype, refers to the (custom) field type.
*
* @since 2.2.4
*
* @param string $render_class_name The custom field type class to use. Default null.
* @param object $field_type_object This `CMB2_Types` object.
*/
$render_class_name = apply_filters( "cmb2_render_class_{$fieldtype}", $render_class_name, $this );
}
return $render_class_name && class_exists( $render_class_name ) ? $render_class_name : false;
}
/**
* Retrieve text parameter from field's options array (if it has one), or use fallback text
*
* @since 2.0.0
* @param string $text_key Key in field's options array.
* @param string $fallback Fallback text.
* @return string
*/
public function _text( $text_key, $fallback = '' ) {
return $this->field->get_string( $text_key, $fallback );
}
/**
* Determine a file's extension
*
* @since 1.0.0
* @param string $file File url
* @return string|false File extension or false
*/
public function get_file_ext( $file ) {
return CMB2_Utils::get_file_ext( $file );
}
/**
* Get the file name from a url
*
* @since 2.0.0
* @param string $value File url or path
* @return string File name
*/
public function get_file_name_from_path( $value ) {
return CMB2_Utils::get_file_name_from_path( $value );
}
/**
* Combines attributes into a string for a form element
*
* @since 1.1.0
* @param array $attrs Attributes to concatenate
* @param array $attr_exclude Attributes that should NOT be concatenated
* @return string String of attributes for form element
*/
public function concat_attrs( $attrs, $attr_exclude = array() ) {
return CMB2_Utils::concat_attrs( $attrs, $attr_exclude );
}
/**
* Generates repeatable field table markup
*
* @since 1.0.0
*/
public function render_repeatable_field() {
$table_id = $this->field->id() . '_repeat';
$this->_desc( true, true, true );
?>
<div id="<?php echo $table_id; ?>" class="cmb-repeat-table cmb-nested">
<div class="cmb-tbody cmb-field-list">
<?php $this->repeatable_rows(); ?>
</div>
</div>
<p class="cmb-add-row">
<button type="button" data-selector="<?php echo $table_id; ?>" class="cmb-add-row-button button-secondary"><?php echo esc_html( $this->_text( 'add_row_text', esc_html__( 'Add Row', 'cmb2' ) ) ); ?></button>
</p>
<?php
// reset iterator
$this->iterator = 0;
}
/**
* Generates repeatable field rows
*
* @since 1.1.0
*/
public function repeatable_rows() {
$meta_value = array_filter( (array) $this->field->escaped_value() );
// check for default content
$default = $this->field->get_default();
// check for saved data
if ( ! empty( $meta_value ) ) {
$meta_value = is_array( $meta_value ) ? array_filter( $meta_value ) : $meta_value;
$meta_value = ! empty( $meta_value ) ? $meta_value : $default;
} else {
$meta_value = $default;
}
// Loop value array and add a row
if ( ! empty( $meta_value ) ) {
foreach ( (array) $meta_value as $val ) {
$this->field->escaped_value = $val;
$this->repeat_row();
$this->iterator++;
}
} else {
// If value is empty (including empty array), then clear the value.
$this->field->escaped_value = $this->field->value = null;
// Otherwise add one row
$this->repeat_row();
}
// Then add an empty row
$this->field->escaped_value = $default;
$this->iterator = $this->iterator ? $this->iterator : 1;
$this->repeat_row( 'empty-row hidden' );
}
/**
* Generates a repeatable row's markup
*
* @since 1.1.0
* @param string $classes Repeatable table row's class
*/
protected function repeat_row( $classes = 'cmb-repeat-row' ) {
$classes = explode( ' ', $classes );
$classes = array_map( 'sanitize_html_class', $classes );
?>
<div class="cmb-row <?php echo esc_attr( implode( ' ', $classes ) ); ?>">
<div class="cmb-td">
<?php $this->_render(); ?>
</div>
<div class="cmb-td cmb-remove-row">
<button type="button" class="button-secondary cmb-remove-row-button" title="<?php echo esc_attr( $this->_text( 'remove_row_button_title', esc_html__( 'Remove Row', 'cmb2' ) ) ); ?>"><?php echo esc_html( $this->_text( 'remove_row_text', esc_html__( 'Remove', 'cmb2' ) ) ); ?></button>
</div>
</div>
<?php
}
/**
* Generates description markup.
*
* @since 1.0.0
* @param bool $paragraph Paragraph tag or span.
* @param bool $echo Whether to echo description or only return it.
* @param bool $repeat_group Whether to repeat the group.
* @return string Field's description markup.
*/
public function _desc( $paragraph = false, $echo = false, $repeat_group = false ) {
// Prevent description from printing multiple times for repeatable fields
if ( ! $repeat_group && ( $this->field->args( 'repeatable' ) || $this->iterator > 0 ) ) {
return '';
}
$desc = $this->field->args( 'description' );
if ( ! $desc ) {
return;
}
$tag = $paragraph ? 'p' : 'span';
$desc = sprintf( "\n" . '<%1$s class="cmb2-metabox-description">%2$s</%1$s>' . "\n", $tag, $desc );
if ( $echo ) {
echo $desc;
}
return $desc;
}
/**
* Generate field name attribute
*
* @since 1.1.0
* @param string $suffix For multi-part fields
* @return string Name attribute
*/
public function _name( $suffix = '' ) {
return $this->field->args( '_name' ) . ( $this->field->args( 'repeatable' ) ? '[' . $this->iterator . ']' : '' ) . $suffix;
}
/**
* Generate field id attribute
*
* @since 1.1.0
* @param string $suffix For multi-part fields
* @param bool $append_repeatable_iterator Whether to append the iterator attribue if the field is repeatable.
* @return string Id attribute
*/
public function _id( $suffix = '', $append_repeatable_iterator = true ) {
$id = $this->field->id() . $suffix . ( $this->field->args( 'repeatable' ) ? '_' . $this->iterator : '' );
if ( $append_repeatable_iterator && $this->field->args( 'repeatable' ) ) {
$id .= '" data-iterator="' . $this->iterator;
}
return $id;
}
/**
* Handles outputting an 'input' element
*
* @since 1.1.0
* @param array $args Override arguments
* @param string $type Field type
* @return string Form input element
*/
public function input( $args = array(), $type = __FUNCTION__ ) {
return $this->get_new_render_type( 'text', 'CMB2_Type_Text', $args, $type )->render();
}
/**
* Handles outputting an 'textarea' element
*
* @since 1.1.0
* @param array $args Override arguments
* @return string Form textarea element
*/
public function textarea( $args = array() ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Textarea', $args )->render();
}
/**
* Begin Field Types
*/
public function text() {
return $this->input();
}
public function hidden() {
$args = array(
'type' => 'hidden',
'desc' => '',
'class' => 'cmb2-hidden',
);
if ( $this->field->group ) {
$args['data-groupid'] = $this->field->group->id();
$args['data-iterator'] = $this->iterator;
}
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Text', $args, 'input' )->render();
}
public function text_small() {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Text', array(
'class' => 'cmb2-text-small',
'desc' => $this->_desc(),
), 'input' )->render();
}
public function text_medium() {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Text', array(
'class' => 'cmb2-text-medium',
'desc' => $this->_desc(),
), 'input' )->render();
}
public function text_email() {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Text', array(
'class' => 'cmb2-text-email cmb2-text-medium',
'type' => 'email',
), 'input' )->render();
}
public function text_url() {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Text', array(
'class' => 'cmb2-text-url cmb2-text-medium regular-text',
'value' => $this->field->escaped_value( 'esc_url' ),
), 'input' )->render();
}
public function text_money() {
$input = $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Text', array(
'class' => 'cmb2-text-money',
'desc' => $this->_desc(),
), 'input' )->render();
return ( ! $this->field->get_param_callback_result( 'before_field' ) ? '$ ' : ' ' ) . $input;
}
public function textarea_small() {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Textarea', array(
'class' => 'cmb2-textarea-small',
'rows' => 4,
) )->render();
}
public function textarea_code( $args = array() ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Textarea_Code', $args )->render();
}
public function wysiwyg( $args = array() ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Wysiwyg', $args )->render();
}
public function text_date( $args = array() ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Text_Date', $args )->render();
}
// Alias for text_date
public function text_date_timestamp( $args = array() ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Text_Date', $args )->render();
}
public function text_time( $args = array() ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Text_Time', $args )->render();
}
public function text_datetime_timestamp( $args = array() ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Text_Datetime_Timestamp', $args )->render();
}
public function text_datetime_timestamp_timezone( $args = array() ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Text_Datetime_Timestamp_Timezone', $args )->render();
}
public function select_timezone( $args = array() ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Select_Timezone', $args )->render();
}
public function colorpicker( $args = array(), $meta_value = '' ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Colorpicker', $args, $meta_value )->render();
}
public function title( $args = array() ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Title', $args )->render();
}
public function select( $args = array() ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Select', $args )->render();
}
public function taxonomy_select( $args = array() ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Taxonomy_Select', $args )->render();
}
public function taxonomy_select_hierarchical( $args = array() ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Taxonomy_Select_Hierarchical', $args )->render();
}
public function radio( $args = array(), $type = __FUNCTION__ ) {
return $this->get_new_render_type( $type, 'CMB2_Type_Radio', $args, $type )->render();
}
public function radio_inline( $args = array() ) {
return $this->radio( $args, __FUNCTION__ );
}
public function multicheck( $type = 'checkbox' ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Multicheck', array(), $type )->render();
}
public function multicheck_inline() {
return $this->multicheck( 'multicheck_inline' );
}
public function checkbox( $args = array(), $is_checked = null ) {
// Avoid get_new_render_type since we need a different default for the 3rd argument than ''.
$render_class_name = $this->get_render_type_class( __FUNCTION__, 'CMB2_Type_Checkbox' );
$this->type = new $render_class_name( $this, $args, $is_checked );
return $this->type->render();
}
public function taxonomy_radio( $args = array() ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Taxonomy_Radio', $args )->render();
}
public function taxonomy_radio_hierarchical( $args = array() ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Taxonomy_Radio_Hierarchical', $args )->render();
}
public function taxonomy_radio_inline( $args = array() ) {
return $this->taxonomy_radio( $args );
}
public function taxonomy_multicheck( $args = array() ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Taxonomy_Multicheck', $args )->render();
}
public function taxonomy_multicheck_hierarchical( $args = array() ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Taxonomy_Multicheck_Hierarchical', $args )->render();
}
public function taxonomy_multicheck_inline( $args = array() ) {
return $this->taxonomy_multicheck( $args );
}
public function oembed( $args = array() ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_Oembed', $args )->render();
}
public function file_list( $args = array() ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_File_List', $args )->render();
}
public function file( $args = array() ) {
return $this->get_new_render_type( __FUNCTION__, 'CMB2_Type_File', $args )->render();
}
}

View File

@ -0,0 +1,698 @@
<?php
/**
* CMB2 Utilities
*
* @since 1.1.0
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Utils {
/**
* The WordPress ABSPATH constant.
*
* @var string
* @since 2.2.3
*/
protected static $ABSPATH = ABSPATH;
/**
* The url which is used to load local resources.
*
* @var string
* @since 2.0.0
*/
protected static $url = '';
/**
* Utility method that attempts to get an attachment's ID by it's url
*
* @since 1.0.0
* @param string $img_url Attachment url.
* @return int|false Attachment ID or false
*/
public static function image_id_from_url( $img_url ) {
$attachment_id = 0;
$dir = wp_upload_dir();
// Is URL in uploads directory?
if ( false === strpos( $img_url, $dir['baseurl'] . '/' ) ) {
return false;
}
$file = basename( $img_url );
$query_args = array(
'post_type' => 'attachment',
'post_status' => 'inherit',
'fields' => 'ids',
'meta_query' => array(
array(
'value' => $file,
'compare' => 'LIKE',
'key' => '_wp_attachment_metadata',
),
),
);
$query = new WP_Query( $query_args );
if ( $query->have_posts() ) {
foreach ( $query->posts as $post_id ) {
$meta = wp_get_attachment_metadata( $post_id );
$original_file = basename( $meta['file'] );
$cropped_image_files = isset( $meta['sizes'] ) ? wp_list_pluck( $meta['sizes'], 'file' ) : array();
if ( $original_file === $file || in_array( $file, $cropped_image_files ) ) {
$attachment_id = $post_id;
break;
}
}
}
return 0 === $attachment_id ? false : $attachment_id;
}
/**
* Utility method to get a combined list of default and custom registered image sizes
*
* @since 2.2.4
* @link http://core.trac.wordpress.org/ticket/18947
* @global array $_wp_additional_image_sizes
* @return array The image sizes
*/
public static function get_available_image_sizes() {
global $_wp_additional_image_sizes;
$default_image_sizes = array( 'thumbnail', 'medium', 'large' );
foreach ( $default_image_sizes as $size ) {
$image_sizes[ $size ] = array(
'height' => intval( get_option( "{$size}_size_h" ) ),
'width' => intval( get_option( "{$size}_size_w" ) ),
'crop' => get_option( "{$size}_crop" ) ? get_option( "{$size}_crop" ) : false,
);
}
if ( isset( $_wp_additional_image_sizes ) && count( $_wp_additional_image_sizes ) ) {
$image_sizes = array_merge( $image_sizes, $_wp_additional_image_sizes );
}
return $image_sizes;
}
/**
* Utility method to return the closest named size from an array of values
*
* Based off of WordPress's image_get_intermediate_size()
* If the size matches an existing size then it will be used. If there is no
* direct match, then the nearest image size larger than the specified size
* will be used. If nothing is found, then the function will return false.
* Uses get_available_image_sizes() to get all available sizes.
*
* @since 2.2.4
* @param array|string $size Image size. Accepts an array of width and height (in that order).
* @return false|string Named image size e.g. 'thumbnail'
*/
public static function get_named_size( $size ) {
$data = array();
// Find the best match when '$size' is an array.
if ( is_array( $size ) ) {
$image_sizes = self::get_available_image_sizes();
$candidates = array();
foreach ( $image_sizes as $_size => $data ) {
// If there's an exact match to an existing image size, short circuit.
if ( $data['width'] == $size[0] && $data['height'] == $size[1] ) {
$candidates[ $data['width'] * $data['height'] ] = array( $_size, $data );
break;
}
// If it's not an exact match, consider larger sizes with the same aspect ratio.
if ( $data['width'] >= $size[0] && $data['height'] >= $size[1] ) {
/**
* To test for varying crops, we constrain the dimensions of the larger image
* to the dimensions of the smaller image and see if they match.
*/
if ( $data['width'] > $size[0] ) {
$constrained_size = wp_constrain_dimensions( $data['width'], $data['height'], $size[0] );
$expected_size = array( $size[0], $size[1] );
} else {
$constrained_size = wp_constrain_dimensions( $size[0], $size[1], $data['width'] );
$expected_size = array( $data['width'], $data['height'] );
}
// If the image dimensions are within 1px of the expected size, we consider it a match.
$matched = ( abs( $constrained_size[0] - $expected_size[0] ) <= 1 && abs( $constrained_size[1] - $expected_size[1] ) <= 1 );
if ( $matched ) {
$candidates[ $data['width'] * $data['height'] ] = array( $_size, $data );
}
}
}
if ( ! empty( $candidates ) ) {
// Sort the array by size if we have more than one candidate.
if ( 1 < count( $candidates ) ) {
ksort( $candidates );
}
$data = array_shift( $candidates );
$data = $data[0];
} elseif ( ! empty( $image_sizes['thumbnail'] ) && $image_sizes['thumbnail']['width'] >= $size[0] && $image_sizes['thumbnail']['width'] >= $size[1] ) {
/*
* When the size requested is smaller than the thumbnail dimensions, we
* fall back to the thumbnail size.
*/
$data = 'thumbnail';
} else {
return false;
}
} elseif ( ! empty( $image_sizes[ $size ] ) ) {
$data = $size;
}// End if.
// If we still don't have a match at this point, return false.
if ( empty( $data ) ) {
return false;
}
return $data;
}
/**
* Utility method that returns time string offset by timezone
*
* @since 1.0.0
* @param string $tzstring Time string.
* @return string Offset time string
*/
public static function timezone_offset( $tzstring ) {
$tz_offset = 0;
if ( ! empty( $tzstring ) && is_string( $tzstring ) ) {
if ( 'UTC' === substr( $tzstring, 0, 3 ) ) {
$tzstring = str_replace( array( ':15', ':30', ':45' ), array( '.25', '.5', '.75' ), $tzstring );
return intval( floatval( substr( $tzstring, 3 ) ) * HOUR_IN_SECONDS );
}
try {
$date_time_zone_selected = new DateTimeZone( $tzstring );
$tz_offset = timezone_offset_get( $date_time_zone_selected, date_create() );
} catch ( Exception $e ) {
self::log_if_debug( __METHOD__, __LINE__, $e->getMessage() );
}
}
return $tz_offset;
}
/**
* Utility method that returns a timezone string representing the default timezone for the site.
*
* Roughly copied from WordPress, as get_option('timezone_string') will return
* an empty string if no value has been set on the options page.
* A timezone string is required by the wp_timezone_choice() used by the
* select_timezone field.
*
* @since 1.0.0
* @return string Timezone string
*/
public static function timezone_string() {
$current_offset = get_option( 'gmt_offset' );
$tzstring = get_option( 'timezone_string' );
// Remove old Etc mappings. Fallback to gmt_offset.
if ( false !== strpos( $tzstring, 'Etc/GMT' ) ) {
$tzstring = '';
}
if ( empty( $tzstring ) ) { // Create a UTC+- zone if no timezone string exists.
if ( 0 == $current_offset ) {
$tzstring = 'UTC+0';
} elseif ( $current_offset < 0 ) {
$tzstring = 'UTC' . $current_offset;
} else {
$tzstring = 'UTC+' . $current_offset;
}
}
return $tzstring;
}
/**
* Returns a unix timestamp, first checking if value already is a timestamp.
*
* @since 2.0.0
* @param string|int $string Possible timestamp string.
* @return int Time stamp.
*/
public static function make_valid_time_stamp( $string ) {
if ( ! $string ) {
return 0;
}
$valid = self::is_valid_time_stamp( $string );
if ( $valid ) {
$timestamp = (int) $string;
$length = strlen( (string) $timestamp );
$unixlength = strlen( (string) time() );
$diff = $length - $unixlength;
// If value is larger than a unix timestamp, we need to round to the
// nearest unix timestamp (in seconds).
if ( $diff > 0 ) {
$divider = (int) '1' . str_repeat( '0', $diff );
$timestamp = round( $timestamp / $divider );
}
} else {
$timestamp = @strtotime( (string) $string );
}
return $timestamp;
}
/**
* Determine if a value is a valid date.
*
* @since 2.9.1
* @param mixed $date Value to check.
* @return boolean Whether value is a valid date
*/
public static function is_valid_date( $date ) {
return ( is_string( $date ) && @strtotime( $date ) )
|| self::is_valid_time_stamp( $date );
}
/**
* Determine if a value is a valid timestamp
*
* @since 2.0.0
* @param mixed $timestamp Value to check.
* @return boolean Whether value is a valid timestamp
*/
public static function is_valid_time_stamp( $timestamp ) {
return (string) (int) $timestamp === (string) $timestamp
&& $timestamp <= PHP_INT_MAX
&& $timestamp >= ~PHP_INT_MAX;
}
/**
* Checks if a value is 'empty'. Still accepts 0.
*
* @since 2.0.0
* @param mixed $value Value to check.
* @return bool True or false
*/
public static function isempty( $value ) {
return null === $value || '' === $value || false === $value || array() === $value;
}
/**
* Checks if a value is not 'empty'. 0 doesn't count as empty.
*
* @since 2.2.2
* @param mixed $value Value to check.
* @return bool True or false
*/
public static function notempty( $value ) {
return null !== $value && '' !== $value && false !== $value && array() !== $value;
}
/**
* Filters out empty values (not including 0).
*
* @since 2.2.2
* @param mixed $value Value to check.
* @return array True or false.
*/
public static function filter_empty( $value ) {
return array_filter( $value, array( __CLASS__, 'notempty' ) );
}
/**
* Insert a single array item inside another array at a set position
*
* @since 2.0.2
* @param array $array Array to modify. Is passed by reference, and no return is needed. Passed by reference.
* @param array $new New array to insert.
* @param int $position Position in the main array to insert the new array.
*/
public static function array_insert( &$array, $new, $position ) {
$before = array_slice( $array, 0, $position - 1 );
$after = array_diff_key( $array, $before );
$array = array_merge( $before, $new, $after );
}
/**
* Defines the url which is used to load local resources.
* This may need to be filtered for local Window installations.
* If resources do not load, please check the wiki for details.
*
* @since 1.0.1
*
* @param string $path URL path.
* @return string URL to CMB2 resources
*/
public static function url( $path = '' ) {
if ( self::$url ) {
return self::$url . $path;
}
$cmb2_url = self::get_url_from_dir( cmb2_dir() );
/**
* Filter the CMB location url.
*
* @param string $cmb2_url Currently registered url.
*/
self::$url = trailingslashit( apply_filters( 'cmb2_meta_box_url', $cmb2_url, CMB2_VERSION ) );
return self::$url . $path;
}
/**
* Converts a system path to a URL
*
* @since 2.2.2
* @param string $dir Directory path to convert.
* @return string Converted URL.
*/
public static function get_url_from_dir( $dir ) {
$dir = self::normalize_path( $dir );
// Let's test if We are in the plugins or mu-plugins dir.
$test_dir = trailingslashit( $dir ) . 'unneeded.php';
if (
0 === strpos( $test_dir, self::normalize_path( WPMU_PLUGIN_DIR ) )
|| 0 === strpos( $test_dir, self::normalize_path( WP_PLUGIN_DIR ) )
) {
// Ok, then use plugins_url, as it is more reliable.
return trailingslashit( plugins_url( '', $test_dir ) );
}
// Ok, now let's test if we are in the theme dir.
$theme_root = self::normalize_path( get_theme_root() );
if ( 0 === strpos( $dir, $theme_root ) ) {
// Ok, then use get_theme_root_uri.
return set_url_scheme(
trailingslashit(
str_replace(
untrailingslashit( $theme_root ),
untrailingslashit( get_theme_root_uri() ),
$dir
)
)
);
}
// Check to see if it's anywhere in the root directory.
$site_dir = self::get_normalized_abspath();
$site_url = trailingslashit( is_multisite() ? network_site_url() : site_url() );
$url = str_replace(
array( $site_dir, WP_PLUGIN_DIR ),
array( $site_url, WP_PLUGIN_URL ),
$dir
);
return set_url_scheme( $url );
}
/**
* Get the normalized absolute path defined by WordPress.
*
* @since 2.2.6
*
* @return string Normalized absolute path.
*/
protected static function get_normalized_abspath() {
return self::normalize_path( self::$ABSPATH );
}
/**
* `wp_normalize_path` wrapper for back-compat. Normalize a filesystem path.
*
* On windows systems, replaces backslashes with forward slashes
* and forces upper-case drive letters.
* Allows for two leading slashes for Windows network shares, but
* ensures that all other duplicate slashes are reduced to a single.
*
* @since 2.2.0
*
* @param string $path Path to normalize.
* @return string Normalized path.
*/
protected static function normalize_path( $path ) {
if ( function_exists( 'wp_normalize_path' ) ) {
return wp_normalize_path( $path );
}
// Replace newer WP's version of wp_normalize_path.
$path = str_replace( '\\', '/', $path );
$path = preg_replace( '|(?<=.)/+|', '/', $path );
if ( ':' === substr( $path, 1, 1 ) ) {
$path = ucfirst( $path );
}
return $path;
}
/**
* Get timestamp from text date
*
* @since 2.2.0
* @param string $value Date value.
* @param string $date_format Expected date format.
* @return mixed Unix timestamp representing the date.
*/
public static function get_timestamp_from_value( $value, $date_format ) {
$date_object = date_create_from_format( $date_format, $value );
return $date_object ? $date_object->setTime( 0, 0, 0 )->getTimeStamp() : strtotime( $value );
}
/**
* Takes a php date() format string and returns a string formatted to suit for the date/time pickers
* It will work only with the following subset of date() options:
*
* Formats: d, l, j, z, m, F, n, y, and Y.
*
* A slight effort is made to deal with escaped characters.
*
* Other options are ignored, because they would either bring compatibility problems between PHP and JS, or
* bring even more translation troubles.
*
* @since 2.2.0
* @param string $format PHP date format.
* @return string reformatted string
*/
public static function php_to_js_dateformat( $format ) {
// order is relevant here, since the replacement will be done sequentially.
$supported_options = array(
'd' => 'dd', // Day, leading 0.
'j' => 'd', // Day, no 0.
'z' => 'o', // Day of the year, no leading zeroes.
// 'D' => 'D', // Day name short, not sure how it'll work with translations.
'l ' => 'DD ', // Day name full, idem before.
'l, ' => 'DD, ', // Day name full, idem before.
'm' => 'mm', // Month of the year, leading 0.
'n' => 'm', // Month of the year, no leading 0.
// 'M' => 'M', // Month, Short name.
'F ' => 'MM ', // Month, full name.
'F, ' => 'MM, ', // Month, full name.
'y' => 'y', // Year, two digit.
'Y' => 'yy', // Year, full.
'H' => 'HH', // Hour with leading 0 (24 hour).
'G' => 'H', // Hour with no leading 0 (24 hour).
'h' => 'hh', // Hour with leading 0 (12 hour).
'g' => 'h', // Hour with no leading 0 (12 hour).
'i' => 'mm', // Minute with leading 0.
's' => 'ss', // Second with leading 0.
'a' => 'tt', // am/pm.
'A' => 'TT', // AM/PM.
);
foreach ( $supported_options as $php => $js ) {
// replaces every instance of a supported option, but skips escaped characters.
$format = preg_replace( "~(?<!\\\\)$php~", $js, $format );
}
$supported_options = array(
'l' => 'DD', // Day name full, idem before.
'F' => 'MM', // Month, full name.
);
if ( isset( $supported_options[ $format ] ) ) {
$format = $supported_options[ $format ];
}
$format = preg_replace_callback( '~(?:\\\.)+~', array( __CLASS__, 'wrap_escaped_chars' ), $format );
return $format;
}
/**
* Helper function for CMB_Utils::php_to_js_dateformat().
*
* @since 2.2.0
* @param string $value Value to wrap/escape.
* @return string Modified value
*/
public static function wrap_escaped_chars( $value ) {
return '&#39;' . str_replace( '\\', '', $value[0] ) . '&#39;';
}
/**
* Send to debug.log if WP_DEBUG is defined and true
*
* @since 2.2.0
*
* @param string $function Function name.
* @param int $line Line number.
* @param mixed $msg Message to output.
* @param mixed $debug Variable to print_r.
*/
public static function log_if_debug( $function, $line, $msg, $debug = null ) {
if ( defined( 'WP_DEBUG' ) && WP_DEBUG ) {
error_log( "In $function, $line:" . print_r( $msg, true ) . ( $debug ? print_r( $debug, true ) : '' ) );
}
}
/**
* Determine a file's extension
*
* @since 1.0.0
* @param string $file File url.
* @return string|false File extension or false
*/
public static function get_file_ext( $file ) {
$parsed = parse_url( $file, PHP_URL_PATH );
return $parsed ? strtolower( pathinfo( $parsed, PATHINFO_EXTENSION ) ) : false;
}
/**
* Get the file name from a url
*
* @since 2.0.0
* @param string $value File url or path.
* @return string File name
*/
public static function get_file_name_from_path( $value ) {
$parts = explode( '/', $value );
return is_array( $parts ) ? end( $parts ) : $value;
}
/**
* Check if WP version is at least $version.
*
* @since 2.2.2
* @param string $version WP version string to compare.
* @return bool Result of comparison check.
*/
public static function wp_at_least( $version ) {
return version_compare( get_bloginfo( 'version' ), $version, '>=' );
}
/**
* Combines attributes into a string for a form element.
*
* @since 1.1.0
* @param array $attrs Attributes to concatenate.
* @param array $attr_exclude Attributes that should NOT be concatenated.
* @return string String of attributes for form element.
*/
public static function concat_attrs( $attrs, $attr_exclude = array() ) {
$attr_exclude[] = 'rendered';
$attr_exclude[] = 'js_dependencies';
$attributes = '';
foreach ( $attrs as $attr => $val ) {
$excluded = in_array( $attr, (array) $attr_exclude, true );
$empty = false === $val && 'value' !== $attr;
if ( ! $excluded && ! $empty ) {
$val = is_array( $val ) ? implode( ',', $val ) : $val;
// if data attribute, use single quote wraps, else double.
$quotes = self::is_data_attribute( $attr ) ? "'" : '"';
$attributes .= sprintf( ' %1$s=%3$s%2$s%3$s', $attr, $val, $quotes );
}
}
return $attributes;
}
/**
* Check if given attribute is a data attribute.
*
* @since 2.2.5
*
* @param string $att HTML attribute.
* @return boolean
*/
public static function is_data_attribute( $att ) {
return 0 === stripos( $att, 'data-' );
}
/**
* Ensures value is an array.
*
* @since 2.2.3
*
* @param mixed $value Value to ensure is array.
* @param array $default Default array. Defaults to empty array.
*
* @return array The array.
*/
public static function ensure_array( $value, $default = array() ) {
if ( empty( $value ) ) {
return $default;
}
if ( is_array( $value ) || is_object( $value ) ) {
return (array) $value;
}
// Not sure anything would be non-scalar that is not an array or object?
if ( ! is_scalar( $value ) ) {
return $default;
}
return (array) $value;
}
/**
* If number is numeric, normalize it with floatval or intval, depending on if decimal is found.
*
* @since 2.2.6
*
* @param mixed $value Value to normalize (if numeric).
* @return mixed Possibly normalized value.
*/
public static function normalize_if_numeric( $value ) {
if ( is_numeric( $value ) ) {
$value = false !== strpos( $value, '.' ) ? floatval( $value ) : intval( $value );
}
return $value;
}
/**
* Generates a 12 character unique hash from a string.
*
* @since 2.4.0
*
* @param string $string String to create a hash from.
*
* @return string
*/
public static function generate_hash( $string ) {
return substr( base_convert( md5( $string ), 16, 32 ), 0, 12 );
}
}

View File

@ -0,0 +1,427 @@
<?php
/**
* CMB2 Helper Functions
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
/**
* Helper function to provide directory path to CMB2
*
* @since 2.0.0
* @param string $path Path to append.
* @return string Directory with optional path appended
*/
function cmb2_dir( $path = '' ) {
return CMB2_DIR . $path;
}
/**
* Autoloads files with CMB2 classes when needed
*
* @since 1.0.0
* @param string $class_name Name of the class being requested.
*/
function cmb2_autoload_classes( $class_name ) {
if ( 0 !== strpos( $class_name, 'CMB2' ) ) {
return;
}
$path = 'includes';
if ( 'CMB2_Type' === $class_name || 0 === strpos( $class_name, 'CMB2_Type_' ) ) {
$path .= '/types';
}
if ( 'CMB2_REST' === $class_name || 0 === strpos( $class_name, 'CMB2_REST_' ) ) {
$path .= '/rest-api';
}
include_once( cmb2_dir( "$path/{$class_name}.php" ) );
}
/**
* Get instance of the CMB2_Utils class
*
* @since 2.0.0
* @return CMB2_Utils object CMB2 utilities class
*/
function cmb2_utils() {
static $cmb2_utils;
$cmb2_utils = $cmb2_utils ? $cmb2_utils : new CMB2_Utils();
return $cmb2_utils;
}
/**
* Get instance of the CMB2_Ajax class
*
* @since 2.0.0
* @return CMB2_Ajax object CMB2 ajax class
*/
function cmb2_ajax() {
return CMB2_Ajax::get_instance();
}
/**
* Get instance of the CMB2_Option class for the passed metabox ID
*
* @since 2.0.0
*
* @param string $key Option key to fetch.
* @return CMB2_Option object Options class for setting/getting options for metabox
*/
function cmb2_options( $key ) {
return CMB2_Options::get( $key );
}
/**
* Get a cmb oEmbed. Handles oEmbed getting for non-post objects
*
* @since 2.0.0
* @param array $args Arguments. Accepts:
*
* 'url' - URL to retrieve the oEmbed from,
* 'object_id' - $post_id,
* 'object_type' - 'post',
* 'oembed_args' - $embed_args, // array containing 'width', etc
* 'field_id' - false,
* 'cache_key' - false,
* 'wp_error' - true/false, // To return a wp_error object if no embed found.
*
* @return string oEmbed string
*/
function cmb2_get_oembed( $args = array() ) {
$oembed = cmb2_ajax()->get_oembed_no_edit( $args );
// Send back our embed.
if ( $oembed['embed'] && $oembed['embed'] != $oembed['fallback'] ) {
return '<div class="cmb2-oembed">' . $oembed['embed'] . '</div>';
}
$error = sprintf(
/* translators: 1: results for. 2: link to codex.wordpress.org/Embeds */
esc_html__( 'No oEmbed Results Found for %1$s. View more info at %2$s.', 'cmb2' ),
$oembed['fallback'],
'<a href="https://wordpress.org/support/article/embeds/" target="_blank">codex.wordpress.org/Embeds</a>'
);
if ( isset( $args['wp_error'] ) && $args['wp_error'] ) {
return new WP_Error( 'cmb2_get_oembed_result', $error, compact( 'oembed', 'args' ) );
}
// Otherwise, send back error info that no oEmbeds were found.
return '<p class="ui-state-error-text">' . $error . '</p>';
}
/**
* Outputs the return of cmb2_get_oembed.
*
* @since 2.2.2
* @see cmb2_get_oembed
*
* @param array $args oEmbed args.
*/
function cmb2_do_oembed( $args = array() ) {
echo cmb2_get_oembed( $args );
}
add_action( 'cmb2_do_oembed', 'cmb2_do_oembed' );
/**
* A helper function to get an option from a CMB2 options array
*
* @since 1.0.1
* @param string $option_key Option key.
* @param string $field_id Option array field key.
* @param mixed $default Optional default fallback value.
* @return array Options array or specific field
*/
function cmb2_get_option( $option_key, $field_id = '', $default = false ) {
return cmb2_options( $option_key )->get( $field_id, $default );
}
/**
* A helper function to update an option in a CMB2 options array
*
* @since 2.0.0
* @param string $option_key Option key.
* @param string $field_id Option array field key.
* @param mixed $value Value to update data with.
* @param boolean $single Whether data should not be an array.
* @return boolean Success/Failure
*/
function cmb2_update_option( $option_key, $field_id, $value, $single = true ) {
if ( cmb2_options( $option_key )->update( $field_id, $value, false, $single ) ) {
return cmb2_options( $option_key )->set();
}
return false;
}
/**
* Get a CMB2 field object.
*
* @since 1.1.0
* @param array $meta_box Metabox ID or Metabox config array.
* @param array $field_id Field ID or all field arguments.
* @param int|string $object_id Object ID (string for options-page).
* @param string $object_type Type of object being saved. (e.g., post, user, term, comment, or options-page).
* Defaults to metabox object type.
* @return CMB2_Field|null CMB2_Field object unless metabox config cannot be found
*/
function cmb2_get_field( $meta_box, $field_id, $object_id = 0, $object_type = '' ) {
$object_id = $object_id ? $object_id : get_the_ID();
$cmb = $meta_box instanceof CMB2 ? $meta_box : cmb2_get_metabox( $meta_box, $object_id );
if ( ! $cmb ) {
return;
}
$cmb->object_type( $object_type ? $object_type : $cmb->mb_object_type() );
return $cmb->get_field( $field_id );
}
/**
* Get a field's value.
*
* @since 1.1.0
* @param array $meta_box Metabox ID or Metabox config array.
* @param array $field_id Field ID or all field arguments.
* @param int|string $object_id Object ID (string for options-page).
* @param string $object_type Type of object being saved. (e.g., post, user, term, comment, or options-page).
* Defaults to metabox object type.
* @return mixed Maybe escaped value
*/
function cmb2_get_field_value( $meta_box, $field_id, $object_id = 0, $object_type = '' ) {
$field = cmb2_get_field( $meta_box, $field_id, $object_id, $object_type );
return $field->escaped_value();
}
/**
* Because OOP can be scary
*
* @since 2.0.2
* @param array $meta_box_config Metabox Config array.
* @return CMB2 object Instantiated CMB2 object
*/
function new_cmb2_box( array $meta_box_config ) {
return cmb2_get_metabox( $meta_box_config );
}
/**
* Retrieve a CMB2 instance by the metabox ID
*
* @since 2.0.0
* @param mixed $meta_box Metabox ID or Metabox config array.
* @param int|string $object_id Object ID (string for options-page).
* @param string $object_type Type of object being saved.
* (e.g., post, user, term, comment, or options-page).
* Defaults to metabox object type.
* @return CMB2 object
*/
function cmb2_get_metabox( $meta_box, $object_id = 0, $object_type = '' ) {
if ( $meta_box instanceof CMB2 ) {
return $meta_box;
}
if ( is_string( $meta_box ) ) {
$cmb = CMB2_Boxes::get( $meta_box );
} else {
// See if we already have an instance of this metabox.
$cmb = CMB2_Boxes::get( $meta_box['id'] );
// If not, we'll initate a new metabox.
$cmb = $cmb ? $cmb : new CMB2( $meta_box, $object_id );
}
if ( $cmb && $object_id ) {
$cmb->object_id( $object_id );
}
if ( $cmb && $object_type ) {
$cmb->object_type( $object_type );
}
return $cmb;
}
/**
* Returns array of sanitized field values from a metabox (without saving them)
*
* @since 2.0.3
* @param mixed $meta_box Metabox ID or Metabox config array.
* @param array $data_to_sanitize Array of field_id => value data for sanitizing (likely $_POST data).
* @return mixed Array of sanitized values or false if no CMB2 object found
*/
function cmb2_get_metabox_sanitized_values( $meta_box, array $data_to_sanitize ) {
$cmb = cmb2_get_metabox( $meta_box );
return $cmb ? $cmb->get_sanitized_values( $data_to_sanitize ) : false;
}
/**
* Retrieve a metabox form
*
* @since 2.0.0
* @param mixed $meta_box Metabox config array or Metabox ID.
* @param int|string $object_id Object ID (string for options-page).
* @param array $args Optional arguments array.
* @return string CMB2 html form markup
*/
function cmb2_get_metabox_form( $meta_box, $object_id = 0, $args = array() ) {
$object_id = $object_id ? $object_id : get_the_ID();
$cmb = cmb2_get_metabox( $meta_box, $object_id );
ob_start();
// Get cmb form.
cmb2_print_metabox_form( $cmb, $object_id, $args );
$form = ob_get_clean();
return apply_filters( 'cmb2_get_metabox_form', $form, $object_id, $cmb );
}
/**
* Display a metabox form & save it on submission
*
* @since 1.0.0
* @param mixed $meta_box Metabox config array or Metabox ID.
* @param int|string $object_id Object ID (string for options-page).
* @param array $args Optional arguments array.
*/
function cmb2_print_metabox_form( $meta_box, $object_id = 0, $args = array() ) {
$object_id = $object_id ? $object_id : get_the_ID();
$cmb = cmb2_get_metabox( $meta_box, $object_id );
// if passing a metabox ID, and that ID was not found.
if ( ! $cmb ) {
return;
}
$args = wp_parse_args( $args, array(
'form_format' => '<form class="cmb-form" method="post" id="%1$s" enctype="multipart/form-data" encoding="multipart/form-data"><input type="hidden" name="object_id" value="%2$s">%3$s<input type="submit" name="submit-cmb" value="%4$s" class="button-primary"></form>',
'save_button' => esc_html__( 'Save', 'cmb2' ),
'object_type' => $cmb->mb_object_type(),
'cmb_styles' => $cmb->prop( 'cmb_styles' ),
'enqueue_js' => $cmb->prop( 'enqueue_js' ),
) );
// Set object type explicitly (rather than trying to guess from context).
$cmb->object_type( $args['object_type'] );
// Save the metabox if it's been submitted
// check permissions
// @todo more hardening?
if (
$cmb->prop( 'save_fields' )
// check nonce.
&& isset( $_POST['submit-cmb'], $_POST['object_id'], $_POST[ $cmb->nonce() ] )
&& wp_verify_nonce( $_POST[ $cmb->nonce() ], $cmb->nonce() )
&& $object_id && $_POST['object_id'] == $object_id
) {
$cmb->save_fields( $object_id, $cmb->object_type(), $_POST );
}
// Enqueue JS/CSS.
if ( $args['cmb_styles'] ) {
CMB2_Hookup::enqueue_cmb_css();
}
if ( $args['enqueue_js'] ) {
CMB2_Hookup::enqueue_cmb_js();
}
$form_format = apply_filters( 'cmb2_get_metabox_form_format', $args['form_format'], $object_id, $cmb );
$format_parts = explode( '%3$s', $form_format );
// Show cmb form.
printf( $format_parts[0], esc_attr( $cmb->cmb_id ), esc_attr( $object_id ) );
$cmb->show_form();
if ( isset( $format_parts[1] ) && $format_parts[1] ) {
printf( str_ireplace( '%4$s', '%1$s', $format_parts[1] ), esc_attr( $args['save_button'] ) );
}
}
/**
* Display a metabox form (or optionally return it) & save it on submission.
*
* @since 1.0.0
* @param mixed $meta_box Metabox config array or Metabox ID.
* @param int|string $object_id Object ID (string for options-page).
* @param array $args Optional arguments array.
* @return string
*/
function cmb2_metabox_form( $meta_box, $object_id = 0, $args = array() ) {
if ( ! isset( $args['echo'] ) || $args['echo'] ) {
cmb2_print_metabox_form( $meta_box, $object_id, $args );
} else {
return cmb2_get_metabox_form( $meta_box, $object_id, $args );
}
}
if ( ! function_exists( 'date_create_from_format' ) ) {
/**
* Reimplementation of DateTime::createFromFormat for PHP < 5.3. :(
* Borrowed from http://stackoverflow.com/questions/5399075/php-datetimecreatefromformat-in-5-2
*
* @param string $date_format Date format.
* @param string $date_value Date value.
*
* @return DateTime
*/
function date_create_from_format( $date_format, $date_value ) {
$schedule_format = str_replace(
array( 'M', 'Y', 'm', 'd', 'H', 'i', 'a' ),
array( '%b', '%Y', '%m', '%d', '%H', '%M', '%p' ),
$date_format
);
/*
* %Y, %m and %d correspond to date()'s Y m and d.
* %I corresponds to H, %M to i and %p to a
*/
$parsed_time = strptime( $date_value, $schedule_format );
$ymd = sprintf(
/**
* This is a format string that takes six total decimal
* arguments, then left-pads them with zeros to either
* 4 or 2 characters, as needed
*/
'%04d-%02d-%02d %02d:%02d:%02d',
$parsed_time['tm_year'] + 1900, // This will be "111", so we need to add 1900.
$parsed_time['tm_mon'] + 1, // This will be the month minus one, so we add one.
$parsed_time['tm_mday'],
$parsed_time['tm_hour'],
$parsed_time['tm_min'],
$parsed_time['tm_sec']
);
return new DateTime( $ymd );
}
}// End if.
if ( ! function_exists( 'date_timestamp_get' ) ) {
/**
* Returns the Unix timestamp representing the date.
* Reimplementation of DateTime::getTimestamp for PHP < 5.3. :(
*
* @param DateTime $date DateTime instance.
*
* @return int
*/
function date_timestamp_get( DateTime $date ) {
return $date->format( 'U' );
}
}// End if.

View File

@ -0,0 +1,2 @@
<?php
// Silence is golden

View File

@ -0,0 +1,865 @@
<?php
/**
* Handles hooking CMB2 objects/fields into the WordPres REST API
* which can allow fields to be read and/or updated.
*
* @since 2.2.3
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*
* @property-read read_fields Array of readable field objects.
* @property-read edit_fields Array of editable field objects.
* @property-read rest_read Whether CMB2 object is readable via the rest api.
* @property-read rest_edit Whether CMB2 object is editable via the rest api.
*/
class CMB2_REST extends CMB2_Hookup_Base {
/**
* The current CMB2 REST endpoint version
*
* @var string
* @since 2.2.3
*/
const VERSION = '1';
/**
* The CMB2 REST base namespace (v should always be followed by $version)
*
* @var string
* @since 2.2.3
*/
const NAME_SPACE = 'cmb2/v1';
/**
* @var CMB2 object
* @since 2.2.3
*/
public $cmb;
/**
* @var CMB2_REST[] objects
* @since 2.2.3
*/
protected static $boxes = array();
/**
* @var array Array of cmb ids for each type.
* @since 2.2.3
*/
protected static $type_boxes = array(
'post' => array(),
'user' => array(),
'comment' => array(),
'term' => array(),
);
/**
* Array of readable field objects.
*
* @var CMB2_Field[]
* @since 2.2.3
*/
protected $read_fields = array();
/**
* Array of editable field objects.
*
* @var CMB2_Field[]
* @since 2.2.3
*/
protected $edit_fields = array();
/**
* Whether CMB2 object is readable via the rest api.
*
* @var boolean
*/
protected $rest_read = false;
/**
* Whether CMB2 object is editable via the rest api.
*
* @var boolean
*/
protected $rest_edit = false;
/**
* A functionalized constructor, used for the hookup action callbacks.
*
* @since 2.2.6
*
* @param CMB2 $cmb The CMB2 object to hookup
*
* @return CMB2_Hookup_Base $hookup The hookup object.
*/
public static function maybe_init_and_hookup( CMB2 $cmb ) {
if ( $cmb->prop( 'show_in_rest' ) && function_exists( 'rest_get_server' ) ) {
$hookup = new self( $cmb );
return $hookup->universal_hooks();
}
return false;
}
/**
* Constructor
*
* @since 2.2.3
*
* @param CMB2 $cmb The CMB2 object to be registered for the API.
*/
public function __construct( CMB2 $cmb ) {
$this->cmb = $cmb;
self::$boxes[ $cmb->cmb_id ] = $this;
$show_value = $this->cmb->prop( 'show_in_rest' );
$this->rest_read = self::is_readable( $show_value );
$this->rest_edit = self::is_editable( $show_value );
}
/**
* Hooks to register on frontend and backend.
*
* @since 2.2.3
*
* @return void
*/
public function universal_hooks() {
// hook up the CMB rest endpoint classes
$this->once( 'rest_api_init', array( __CLASS__, 'init_routes' ), 0 );
if ( function_exists( 'register_rest_field' ) ) {
$this->once( 'rest_api_init', array( __CLASS__, 'register_cmb2_fields' ), 50 );
}
$this->declare_read_edit_fields();
add_filter( 'is_protected_meta', array( $this, 'is_protected_meta' ), 10, 3 );
return $this;
}
/**
* Initiate the CMB2 Boxes and Fields routes
*
* @since 2.2.3
*
* @return void
*/
public static function init_routes() {
$wp_rest_server = rest_get_server();
$boxes_controller = new CMB2_REST_Controller_Boxes( $wp_rest_server );
$boxes_controller->register_routes();
$fields_controller = new CMB2_REST_Controller_Fields( $wp_rest_server );
$fields_controller->register_routes();
}
/**
* Loop through REST boxes and call register_rest_field for each object type.
*
* @since 2.2.3
*
* @return void
*/
public static function register_cmb2_fields() {
$alltypes = $taxonomies = array();
foreach ( self::$boxes as $cmb_id => $rest_box ) {
// Hook box specific filter callbacks.
$callback = $rest_box->cmb->prop( 'register_rest_field_cb' );
if ( is_callable( $callback ) ) {
call_user_func( $callback, $rest_box );
continue;
}
$types = array_flip( $rest_box->cmb->box_types( array( 'post' ) ) );
if ( isset( $types['user'] ) ) {
unset( $types['user'] );
self::$type_boxes['user'][ $cmb_id ] = $cmb_id;
}
if ( isset( $types['comment'] ) ) {
unset( $types['comment'] );
self::$type_boxes['comment'][ $cmb_id ] = $cmb_id;
}
if ( isset( $types['term'] ) ) {
unset( $types['term'] );
$taxonomies = array_merge(
$taxonomies,
CMB2_Utils::ensure_array( $rest_box->cmb->prop( 'taxonomies' ) )
);
self::$type_boxes['term'][ $cmb_id ] = $cmb_id;
}
if ( ! empty( $types ) ) {
$alltypes = array_merge( $alltypes, array_flip( $types ) );
self::$type_boxes['post'][ $cmb_id ] = $cmb_id;
}
}
$alltypes = array_unique( $alltypes );
if ( ! empty( $alltypes ) ) {
self::register_rest_field( $alltypes, 'post' );
}
if ( ! empty( self::$type_boxes['user'] ) ) {
self::register_rest_field( 'user', 'user' );
}
if ( ! empty( self::$type_boxes['comment'] ) ) {
self::register_rest_field( 'comment', 'comment' );
}
if ( ! empty( self::$type_boxes['term'] ) ) {
self::register_rest_field( $taxonomies, 'term' );
}
}
/**
* Wrapper for register_rest_field.
*
* @since 2.2.3
*
* @param string|array $object_types Object(s) the field is being registered
* to, "post"|"term"|"comment" etc.
* @param string $object_types Canonical object type for callbacks.
*
* @return void
*/
protected static function register_rest_field( $object_types, $object_type ) {
register_rest_field( $object_types, 'cmb2', array(
'get_callback' => array( __CLASS__, "get_{$object_type}_rest_values" ),
'update_callback' => array( __CLASS__, "update_{$object_type}_rest_values" ),
'schema' => null, // @todo add schema
) );
}
/**
* Setup readable and editable fields.
*
* @since 2.2.3
*
* @return void
*/
protected function declare_read_edit_fields() {
foreach ( $this->cmb->prop( 'fields' ) as $field ) {
$show_in_rest = isset( $field['show_in_rest'] ) ? $field['show_in_rest'] : null;
if ( false === $show_in_rest ) {
continue;
}
if ( $this->can_read( $show_in_rest ) ) {
$this->read_fields[] = $field['id'];
}
if ( $this->can_edit( $show_in_rest ) ) {
$this->edit_fields[] = $field['id'];
}
}
}
/**
* Determines if a field is readable based on it's show_in_rest value
* and the box's show_in_rest value.
*
* @since 2.2.3
*
* @param bool $show_in_rest Field's show_in_rest value. Default null.
*
* @return bool Whether field is readable.
*/
protected function can_read( $show_in_rest ) {
// if 'null', then use default box value.
if ( null === $show_in_rest ) {
return $this->rest_read;
}
// Else check if the value represents readable.
return self::is_readable( $show_in_rest );
}
/**
* Determines if a field is editable based on it's show_in_rest value
* and the box's show_in_rest value.
*
* @since 2.2.3
*
* @param bool $show_in_rest Field's show_in_rest value. Default null.
*
* @return bool Whether field is editable.
*/
protected function can_edit( $show_in_rest ) {
// if 'null', then use default box value.
if ( null === $show_in_rest ) {
return $this->rest_edit;
}
// Else check if the value represents editable.
return self::is_editable( $show_in_rest );
}
/**
* Handler for getting post custom field data.
*
* @since 2.2.3
*
* @param array $object The object data from the response
* @param string $field_name Name of field
* @param WP_REST_Request $request Current request
* @param string $object_type The request object type
*
* @return mixed
*/
public static function get_post_rest_values( $object, $field_name, $request, $object_type ) {
if ( 'cmb2' === $field_name ) {
return self::get_rest_values( $object, $request, $object_type, 'post' );
}
}
/**
* Handler for getting user custom field data.
*
* @since 2.2.3
*
* @param array $object The object data from the response
* @param string $field_name Name of field
* @param WP_REST_Request $request Current request
* @param string $object_type The request object type
*
* @return mixed
*/
public static function get_user_rest_values( $object, $field_name, $request, $object_type ) {
if ( 'cmb2' === $field_name ) {
return self::get_rest_values( $object, $request, $object_type, 'user' );
}
}
/**
* Handler for getting comment custom field data.
*
* @since 2.2.3
*
* @param array $object The object data from the response
* @param string $field_name Name of field
* @param WP_REST_Request $request Current request
* @param string $object_type The request object type
*
* @return mixed
*/
public static function get_comment_rest_values( $object, $field_name, $request, $object_type ) {
if ( 'cmb2' === $field_name ) {
return self::get_rest_values( $object, $request, $object_type, 'comment' );
}
}
/**
* Handler for getting term custom field data.
*
* @since 2.2.3
*
* @param array $object The object data from the response
* @param string $field_name Name of field
* @param WP_REST_Request $request Current request
* @param string $object_type The request object type
*
* @return mixed
*/
public static function get_term_rest_values( $object, $field_name, $request, $object_type ) {
if ( 'cmb2' === $field_name ) {
return self::get_rest_values( $object, $request, $object_type, 'term' );
}
}
/**
* Handler for getting custom field data.
*
* @since 2.2.3
*
* @param array $object The object data from the response
* @param WP_REST_Request $request Current request
* @param string $object_type The request object type
* @param string $main_object_type The cmb main object type
*
* @return mixed
*/
protected static function get_rest_values( $object, $request, $object_type, $main_object_type = 'post' ) {
if ( ! isset( $object['id'] ) ) {
return;
}
$values = array();
if ( ! empty( self::$type_boxes[ $main_object_type ] ) ) {
foreach ( self::$type_boxes[ $main_object_type ] as $cmb_id ) {
$rest_box = self::$boxes[ $cmb_id ];
if ( ! $rest_box->cmb->is_box_type( $object_type ) ) {
continue;
}
$result = self::get_box_rest_values( $rest_box, $object['id'], $main_object_type );
if ( ! empty( $result ) ) {
if ( empty( $values[ $cmb_id ] ) ) {
$values[ $cmb_id ] = $result;
} else {
$values[ $cmb_id ] = array_merge( $values[ $cmb_id ], $result );
}
}
}
}
return $values;
}
/**
* Get box rest values.
*
* @since 2.7.0
*
* @param CMB2_REST $rest_box The CMB2_REST object.
* @param integer $object_id The object ID.
* @param string $main_object_type The object type (post, user, term, etc)
*
* @return array Array of box rest values.
*/
public static function get_box_rest_values( $rest_box, $object_id = 0, $main_object_type = 'post' ) {
$rest_box->cmb->object_id( $object_id );
$rest_box->cmb->object_type( $main_object_type );
$values = array();
foreach ( $rest_box->read_fields as $field_id ) {
$field = $rest_box->cmb->get_field( $field_id );
$field->object_id( $object_id );
$field->object_type( $main_object_type );
$values[ $field->id( true ) ] = $field->get_rest_value();
if ( $field->args( 'has_supporting_data' ) ) {
$field = $field->get_supporting_field();
$values[ $field->id( true ) ] = $field->get_rest_value();
}
}
return $values;
}
/**
* Handler for updating post custom field data.
*
* @since 2.2.3
*
* @param mixed $values The value of the field
* @param object $object The object from the response
* @param string $field_name Name of field
* @param WP_REST_Request $request Current request
* @param string $object_type The request object type
*
* @return bool|int
*/
public static function update_post_rest_values( $values, $object, $field_name, $request, $object_type ) {
if ( 'cmb2' === $field_name ) {
return self::update_rest_values( $values, $object, $request, $object_type, 'post' );
}
}
/**
* Handler for updating user custom field data.
*
* @since 2.2.3
*
* @param mixed $values The value of the field
* @param object $object The object from the response
* @param string $field_name Name of field
* @param WP_REST_Request $request Current request
* @param string $object_type The request object type
*
* @return bool|int
*/
public static function update_user_rest_values( $values, $object, $field_name, $request, $object_type ) {
if ( 'cmb2' === $field_name ) {
return self::update_rest_values( $values, $object, $request, $object_type, 'user' );
}
}
/**
* Handler for updating comment custom field data.
*
* @since 2.2.3
*
* @param mixed $values The value of the field
* @param object $object The object from the response
* @param string $field_name Name of field
* @param WP_REST_Request $request Current request
* @param string $object_type The request object type
*
* @return bool|int
*/
public static function update_comment_rest_values( $values, $object, $field_name, $request, $object_type ) {
if ( 'cmb2' === $field_name ) {
return self::update_rest_values( $values, $object, $request, $object_type, 'comment' );
}
}
/**
* Handler for updating term custom field data.
*
* @since 2.2.3
*
* @param mixed $values The value of the field
* @param object $object The object from the response
* @param string $field_name Name of field
* @param WP_REST_Request $request Current request
* @param string $object_type The request object type
*
* @return bool|int
*/
public static function update_term_rest_values( $values, $object, $field_name, $request, $object_type ) {
if ( 'cmb2' === $field_name ) {
return self::update_rest_values( $values, $object, $request, $object_type, 'term' );
}
}
/**
* Handler for updating custom field data.
*
* @since 2.2.3
*
* @param mixed $values The value of the field
* @param object $object The object from the response
* @param WP_REST_Request $request Current request
* @param string $object_type The request object type
* @param string $main_object_type The cmb main object type
*
* @return bool|int
*/
protected static function update_rest_values( $values, $object, $request, $object_type, $main_object_type = 'post' ) {
if ( empty( $values ) || ! is_array( $values ) ) {
return;
}
$object_id = self::get_object_id( $object, $main_object_type );
if ( ! $object_id ) {
return;
}
$updated = array();
if ( ! empty( self::$type_boxes[ $main_object_type ] ) ) {
foreach ( self::$type_boxes[ $main_object_type ] as $cmb_id ) {
$result = self::santize_box_rest_values( $values, self::$boxes[ $cmb_id ], $object_id, $main_object_type );
if ( ! empty( $result ) ) {
$updated[ $cmb_id ] = $result;
}
}
}
return $updated;
}
/**
* Updates box rest values.
*
* @since 2.7.0
*
* @param array $values Array of values.
* @param CMB2_REST $rest_box The CMB2_REST object.
* @param integer $object_id The object ID.
* @param string $main_object_type The object type (post, user, term, etc)
*
* @return mixed|bool Array of updated statuses if successful.
*/
public static function santize_box_rest_values( $values, $rest_box, $object_id = 0, $main_object_type = 'post' ) {
if ( ! array_key_exists( $rest_box->cmb->cmb_id, $values ) ) {
return false;
}
$rest_box->cmb->object_id( $object_id );
$rest_box->cmb->object_type( $main_object_type );
return $rest_box->sanitize_box_values( $values );
}
/**
* Loop through box fields and sanitize the values.
*
* @since 2.2.o
*
* @param array $values Array of values being provided.
* @return array Array of updated/sanitized values.
*/
public function sanitize_box_values( array $values ) {
$updated = array();
$this->cmb->pre_process();
foreach ( $this->edit_fields as $field_id ) {
$updated[ $field_id ] = $this->sanitize_field_value( $values, $field_id );
}
$this->cmb->after_save();
return $updated;
}
/**
* Handles returning a sanitized field value.
*
* @since 2.2.3
*
* @param array $values Array of values being provided.
* @param string $field_id The id of the field to update.
*
* @return mixed The results of saving/sanitizing a field value.
*/
protected function sanitize_field_value( array $values, $field_id ) {
if ( ! array_key_exists( $field_id, $values[ $this->cmb->cmb_id ] ) ) {
return;
}
$field = $this->cmb->get_field( $field_id );
if ( 'title' == $field->type() ) {
return;
}
$field->object_id( $this->cmb->object_id() );
$field->object_type( $this->cmb->object_type() );
if ( 'group' == $field->type() ) {
return $this->sanitize_group_value( $values, $field );
}
return $field->save_field( $values[ $this->cmb->cmb_id ][ $field_id ] );
}
/**
* Handles returning a sanitized group field value.
*
* @since 2.2.3
*
* @param array $values Array of values being provided.
* @param CMB2_Field $field CMB2_Field object.
*
* @return mixed The results of saving/sanitizing the group field value.
*/
protected function sanitize_group_value( array $values, CMB2_Field $field ) {
$fields = $field->fields();
if ( empty( $fields ) ) {
return;
}
$this->cmb->data_to_save[ $field->_id( '', false ) ] = $values[ $this->cmb->cmb_id ][ $field->_id( '', false ) ];
return $this->cmb->save_group_field( $field );
}
/**
* Filter whether a meta key is protected.
*
* @since 2.2.3
*
* @param bool $protected Whether the key is protected. Default false.
* @param string $meta_key Meta key.
* @param string $meta_type Meta type.
*/
public function is_protected_meta( $protected, $meta_key, $meta_type ) {
if ( $this->field_can_edit( $meta_key ) ) {
return false;
}
return $protected;
}
/**
* Get the object ID for the given object/type.
*
* @since 2.2.3
*
* @param mixed $object The object to get the ID for.
* @param string $object_type The object type we are looking for.
*
* @return int The object ID if found.
*/
public static function get_object_id( $object, $object_type = 'post' ) {
switch ( $object_type ) {
case 'user':
case 'post':
if ( isset( $object->ID ) ) {
return intval( $object->ID );
}
case 'comment':
if ( isset( $object->comment_ID ) ) {
return intval( $object->comment_ID );
}
case 'term':
if ( is_array( $object ) && isset( $object['term_id'] ) ) {
return intval( $object['term_id'] );
} elseif ( isset( $object->term_id ) ) {
return intval( $object->term_id );
}
}
return 0;
}
/**
* Checks if a given field can be read.
*
* @since 2.2.3
*
* @param string|CMB2_Field $field_id Field ID or CMB2_Field object.
* @param boolean $return_object Whether to return the Field object.
*
* @return mixed False if field can't be read or true|CMB2_Field object.
*/
public function field_can_read( $field_id, $return_object = false ) {
return $this->field_can( 'read_fields', $field_id, $return_object );
}
/**
* Checks if a given field can be edited.
*
* @since 2.2.3
*
* @param string|CMB2_Field $field_id Field ID or CMB2_Field object.
* @param boolean $return_object Whether to return the Field object.
*
* @return mixed False if field can't be edited or true|CMB2_Field object.
*/
public function field_can_edit( $field_id, $return_object = false ) {
return $this->field_can( 'edit_fields', $field_id, $return_object );
}
/**
* Checks if a given field can be read or edited.
*
* @since 2.2.3
*
* @param string $type Whether we are checking for read or edit fields.
* @param string|CMB2_Field $field_id Field ID or CMB2_Field object.
* @param boolean $return_object Whether to return the Field object.
*
* @return mixed False if field can't be read or edited or true|CMB2_Field object.
*/
protected function field_can( $type, $field_id, $return_object = false ) {
if ( ! in_array( $field_id instanceof CMB2_Field ? $field_id->id() : $field_id, $this->{$type}, true ) ) {
return false;
}
return $return_object ? $this->cmb->get_field( $field_id ) : true;
}
/**
* Get a CMB2_REST instance object from the registry by a CMB2 id.
*
* @since 2.2.3
*
* @param string $cmb_id CMB2 config id
*
* @return CMB2_REST|false The CMB2_REST object or false.
*/
public static function get_rest_box( $cmb_id ) {
return isset( self::$boxes[ $cmb_id ] ) ? self::$boxes[ $cmb_id ] : false;
}
/**
* Remove a CMB2_REST instance object from the registry.
*
* @since 2.2.3
*
* @param string $cmb_id A CMB2 instance id.
*/
public static function remove( $cmb_id ) {
if ( array_key_exists( $cmb_id, self::$boxes ) ) {
unset( self::$boxes[ $cmb_id ] );
}
}
/**
* Retrieve all CMB2_REST instances from the registry.
*
* @since 2.2.3
* @return CMB2[] Array of all registered CMB2_REST instances.
*/
public static function get_all() {
return self::$boxes;
}
/**
* Checks if given value is readable.
*
* Value is considered readable if it is not empty and if it does not match the editable blacklist.
*
* @since 2.2.3
*
* @param mixed $value Value to check.
*
* @return boolean Whether value is considered readable.
*/
public static function is_readable( $value ) {
return ! empty( $value ) && ! in_array( $value, array(
WP_REST_Server::CREATABLE,
WP_REST_Server::EDITABLE,
WP_REST_Server::DELETABLE,
), true );
}
/**
* Checks if given value is editable.
*
* Value is considered editable if matches the editable whitelist.
*
* @since 2.2.3
*
* @param mixed $value Value to check.
*
* @return boolean Whether value is considered editable.
*/
public static function is_editable( $value ) {
return in_array( $value, array(
WP_REST_Server::EDITABLE,
WP_REST_Server::ALLMETHODS,
), true );
}
/**
* Magic getter for our object.
*
* @param string $field
* @throws Exception Throws an exception if the field is invalid.
*
* @return mixed
*/
public function __get( $field ) {
switch ( $field ) {
case 'read_fields':
case 'edit_fields':
case 'rest_read':
case 'rest_edit':
return $this->{$field};
default:
throw new Exception( 'Invalid ' . __CLASS__ . ' property: ' . $field );
}
}
}

View File

@ -0,0 +1,448 @@
<?php
if ( ! class_exists( 'WP_REST_Controller' ) ) {
// Shim the WP_REST_Controller class if wp-api plugin not installed, & not in core.
require_once cmb2_dir( 'includes/shim/WP_REST_Controller.php' );
}
/**
* Creates CMB2 objects/fields endpoint for WordPres REST API.
* Allows access to fields registered to a specific post type and more.
*
* @todo Add better documentation.
* @todo Research proper schema.
*
* @since 2.2.3
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
abstract class CMB2_REST_Controller extends WP_REST_Controller {
/**
* The namespace of this controller's route.
*
* @var string
*/
protected $namespace = CMB2_REST::NAME_SPACE;
/**
* The base of this controller's route.
*
* @var string
*/
protected $rest_base;
/**
* The current request object
*
* @var WP_REST_Request $request
* @since 2.2.3
*/
public $request;
/**
* The current server object
*
* @var WP_REST_Server $server
* @since 2.2.3
*/
public $server;
/**
* Box object id
*
* @var mixed
* @since 2.2.3
*/
public $object_id = null;
/**
* Box object type
*
* @var string
* @since 2.2.3
*/
public $object_type = '';
/**
* CMB2 Instance
*
* @var CMB2_REST
*/
protected $rest_box;
/**
* CMB2_Field Instance
*
* @var CMB2_Field
*/
protected $field;
/**
* The initial route
*
* @var string
* @since 2.2.3
*/
protected static $route = '';
/**
* Defines which endpoint the initial request is.
*
* @var string $request_type
* @since 2.2.3
*/
protected static $request_type = '';
/**
* Constructor
*
* @since 2.2.3
*/
public function __construct( WP_REST_Server $wp_rest_server ) {
$this->server = $wp_rest_server;
}
/**
* A wrapper for `apply_filters` which checks for box/field properties to hook to the filter.
*
* Checks if a CMB object callback property exists, and if it does,
* hook it to the permissions filter.
*
* @since 2.2.3
*
* @param string $filter The name of the filter to apply.
* @param bool $default_access The default access for this request.
*
* @return void
*/
public function maybe_hook_callback_and_apply_filters( $filter, $default_access ) {
if ( ! $this->rest_box && $this->request->get_param( 'cmb_id' ) ) {
$this->rest_box = CMB2_REST::get_rest_box( $this->request->get_param( 'cmb_id' ) );
}
$default_access = $this->maybe_hook_registered_callback( $filter, $default_access );
/**
* Apply the permissions check filter.
*
* @since 2.2.3
*
* @param bool $default_access Whether this CMB2 endpoint can be accessed.
* @param object $controller This CMB2_REST_Controller object.
*/
$default_access = apply_filters( $filter, $default_access, $this );
$this->maybe_unhook_registered_callback( $filter );
return $default_access;
}
/**
* Checks if the CMB2 box has any registered callback parameters for the given filter.
*
* The registered handlers will have a property name which matches the filter, except:
* - The 'cmb2_api' prefix will be removed
* - A '_cb' suffix will be added (to stay inline with other '*_cb' parameters).
*
* @since 2.2.3
*
* @param string $filter The filter name.
* @param bool $default_val The default filter value.
*
* @return bool The possibly-modified filter value (if the '*_cb' param is non-callable).
*/
public function maybe_hook_registered_callback( $filter, $default_val ) {
if ( ! $this->rest_box || is_wp_error( $this->rest_box ) ) {
return $default_val;
}
// Hook box specific filter callbacks.
$val = $this->rest_box->cmb->maybe_hook_parameter( $filter, $default_val );
if ( null !== $val ) {
$default_val = $val;
}
return $default_val;
}
/**
* Unhooks any CMB2 box registered callback parameters for the given filter.
*
* @since 2.2.3
*
* @param string $filter The filter name.
*
* @return void
*/
public function maybe_unhook_registered_callback( $filter ) {
if ( ! $this->rest_box || is_wp_error( $this->rest_box ) ) {
return;
}
// Unhook box specific filter callbacks.
$this->rest_box->cmb->maybe_hook_parameter( $filter, null, 'remove_filter' );
}
/**
* Prepare a CMB2 object for serialization
*
* @since 2.2.3
*
* @param mixed $data
* @return array $data
*/
public function prepare_item( $data ) {
return $this->prepare_item_for_response( $data, $this->request );
}
/**
* Output buffers a callback and returns the results.
*
* @since 2.2.3
*
* @param mixed $cb Callable function/method.
* @return mixed Results of output buffer after calling function/method.
*/
public function get_cb_results( $cb ) {
$args = func_get_args();
array_shift( $args ); // ignore $cb
ob_start();
call_user_func_array( $cb, $args );
return ob_get_clean();
}
/**
* Prepare the CMB2 item for the REST response.
*
* @since 2.2.3
*
* @param mixed $item WordPress representation of the item.
* @param WP_REST_Request $request Request object.
* @return WP_REST_Response $response
*/
public function prepare_item_for_response( $data, $request = null ) {
$data = $this->filter_response_by_context( $data, $this->request['context'] );
/**
* Filter the prepared CMB2 item response.
*
* @since 2.2.3
*
* @param mixed $data Prepared data
* @param object $request The WP_REST_Request object
* @param object $cmb2_endpoints This endpoints object
*/
return apply_filters( 'cmb2_rest_prepare', rest_ensure_response( $data ), $this->request, $this );
}
/**
* Initiates the request property and the rest_box property if box is readable.
*
* @since 2.2.3
*
* @param WP_REST_Request $request Request object.
* @param string $request_type A description of the type of request being made.
*
* @return void
*/
protected function initiate_rest_read_box( $request, $request_type ) {
$this->initiate_rest_box( $request, $request_type );
if ( ! is_wp_error( $this->rest_box ) && ! $this->rest_box->rest_read ) {
$this->rest_box = new WP_Error( 'cmb2_rest_no_read_error', __( 'This box does not have read permissions.', 'cmb2' ), array(
'status' => 403,
) );
}
}
/**
* Initiates the request property and the rest_box property if box is writeable.
*
* @since 2.2.3
*
* @param WP_REST_Request $request Request object.
* @param string $request_type A description of the type of request being made.
*
* @return void
*/
protected function initiate_rest_edit_box( $request, $request_type ) {
$this->initiate_rest_box( $request, $request_type );
if ( ! is_wp_error( $this->rest_box ) && ! $this->rest_box->rest_edit ) {
$this->rest_box = new WP_Error( 'cmb2_rest_no_write_error', __( 'This box does not have write permissions.', 'cmb2' ), array(
'status' => 403,
) );
}
}
/**
* Initiates the request property and the rest_box property.
*
* @since 2.2.3
*
* @param WP_REST_Request $request Request object.
* @param string $request_type A description of the type of request being made.
*
* @return void
*/
protected function initiate_rest_box( $request, $request_type ) {
$this->initiate_request( $request, $request_type );
$this->rest_box = CMB2_REST::get_rest_box( $this->request->get_param( 'cmb_id' ) );
if ( ! $this->rest_box ) {
$this->rest_box = new WP_Error( 'cmb2_rest_box_not_found_error', __( 'No box found by that id. A box needs to be registered with the "show_in_rest" parameter configured.', 'cmb2' ), array(
'status' => 403,
) );
} else {
if ( isset( $this->request['object_id'] ) ) {
$this->rest_box->cmb->object_id( sanitize_text_field( $this->request['object_id'] ) );
}
if ( isset( $this->request['object_type'] ) ) {
$this->rest_box->cmb->object_type( sanitize_text_field( $this->request['object_type'] ) );
}
}
}
/**
* Initiates the request property and sets up the initial static properties.
*
* @since 2.2.3
*
* @param WP_REST_Request $request Request object.
* @param string $request_type A description of the type of request being made.
*
* @return void
*/
public function initiate_request( $request, $request_type ) {
$this->request = $request;
if ( ! isset( $this->request['context'] ) || empty( $this->request['context'] ) ) {
$this->request['context'] = 'view';
}
if ( ! self::$request_type ) {
self::$request_type = $request_type;
}
if ( ! self::$route ) {
self::$route = $this->request->get_route();
}
}
/**
* Useful when getting `_embed`-ed items
*
* @since 2.2.3
*
* @return string Initial requested type.
*/
public static function get_intial_request_type() {
return self::$request_type;
}
/**
* Useful when getting `_embed`-ed items
*
* @since 2.2.3
*
* @return string Initial requested route.
*/
public static function get_intial_route() {
return self::$route;
}
/**
* Get CMB2 fields schema, conforming to JSON Schema
*
* @since 2.2.3
*
* @return array
*/
public function get_item_schema() {
$schema = array(
'$schema' => 'http://json-schema.org/draft-04/schema#',
'title' => 'CMB2',
'type' => 'object',
'properties' => array(
'description' => array(
'description' => __( 'A human-readable description of the object.', 'cmb2' ),
'type' => 'string',
'context' => array(
'view',
),
),
'name' => array(
'description' => __( 'The id for the object.', 'cmb2' ),
'type' => 'integer',
'context' => array(
'view',
),
),
'name' => array(
'description' => __( 'The title for the object.', 'cmb2' ),
'type' => 'string',
'context' => array(
'view',
),
),
),
);
return $this->add_additional_fields_schema( $schema );
}
/**
* Return an array of contextual links for endpoint/object
*
* @link http://v2.wp-api.org/extending/linking/
* @link http://www.iana.org/assignments/link-relations/link-relations.xhtml
*
* @since 2.2.3
*
* @param mixed $object Object to build links from.
*
* @return array Array of links
*/
abstract protected function prepare_links( $object );
/**
* Get whitelisted query strings from URL for appending to link URLS.
*
* @since 2.2.3
*
* @return string URL query stringl
*/
public function get_query_string() {
$defaults = array(
'object_id' => 0,
'object_type' => '',
'_rendered' => '',
// '_embed' => '',
);
$query_string = '';
foreach ( $defaults as $key => $value ) {
if ( isset( $this->request[ $key ] ) ) {
$query_string .= $query_string ? '&' : '?';
$query_string .= $key;
if ( $value = sanitize_text_field( $this->request[ $key ] ) ) {
$query_string .= '=' . $value;
}
}
}
return $query_string;
}
}

View File

@ -0,0 +1,270 @@
<?php
/**
* CMB2 objects/boxes endpoint for WordPres REST API.
* Allows access to boxes configuration data.
*
* @todo Add better documentation.
* @todo Research proper schema.
*
* @since 2.2.3
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_REST_Controller_Boxes extends CMB2_REST_Controller {
/**
* The base of this controller's route.
*
* @var string
*/
protected $rest_base = 'boxes';
/**
* The combined $namespace and $rest_base for these routes.
*
* @var string
*/
protected $namespace_base = '';
/**
* Constructor
*
* @since 2.2.3
*/
public function __construct( WP_REST_Server $wp_rest_server ) {
$this->namespace_base = $this->namespace . '/' . $this->rest_base;
parent::__construct( $wp_rest_server );
}
/**
* Register the routes for the objects of the controller.
*
* @since 2.2.3
*/
public function register_routes() {
$args = array(
'_embed' => array(
'description' => __( 'Includes the registered fields for the box in the response.', 'cmb2' ),
),
);
// @todo determine what belongs in the context param.
// $args['context'] = $this->get_context_param();
// $args['context']['required'] = false;
// $args['context']['default'] = 'view';
// $args['context']['enum'] = array( 'view', 'embed' );
// Returns all boxes data.
register_rest_route( $this->namespace, '/' . $this->rest_base, array(
array(
'methods' => WP_REST_Server::READABLE,
'permission_callback' => array( $this, 'get_items_permissions_check' ),
'callback' => array( $this, 'get_items' ),
'args' => $args,
),
'schema' => array( $this, 'get_item_schema' ),
) );
$args['_rendered'] = array(
'description' => __( 'Includes the fully rendered attributes, \'form_open\', \'form_close\', as well as the enqueued \'js_dependencies\' script handles, and \'css_dependencies\' stylesheet handles.', 'cmb2' ),
);
// Returns specific box's data.
register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<cmb_id>[\w-]+)', array(
array(
'methods' => WP_REST_Server::READABLE,
'permission_callback' => array( $this, 'get_item_permissions_check' ),
'callback' => array( $this, 'get_item' ),
'args' => $args,
),
'schema' => array( $this, 'get_item_schema' ),
) );
}
/**
* Check if a given request has access to get boxes.
*
* @since 2.2.3
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|boolean
*/
public function get_items_permissions_check( $request ) {
$this->initiate_request( $request, __FUNCTION__ );
/**
* By default, no special permissions needed.
*
* @since 2.2.3
*
* @param bool $can_access Whether this CMB2 endpoint can be accessed.
* @param object $controller This CMB2_REST_Controller object.
*/
return apply_filters( 'cmb2_api_get_boxes_permissions_check', true, $this );
}
/**
* Get all public CMB2 boxes.
*
* @since 2.2.3
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|WP_REST_Response
*/
public function get_items( $request ) {
$this->initiate_request( $request, 'boxes_read' );
$boxes = CMB2_REST::get_all();
if ( empty( $boxes ) ) {
return new WP_Error( 'cmb2_rest_no_boxes', __( 'No boxes found.', 'cmb2' ), array(
'status' => 403,
) );
}
$boxes_data = array();
// Loop and prepare boxes data.
foreach ( $boxes as $this->rest_box ) {
if (
// Make sure this box can be read
$this->rest_box->rest_read
// And make sure current user can view this box.
&& $this->get_item_permissions_check_filter( $this->request )
) {
$boxes_data[] = $this->server->response_to_data(
$this->get_rest_box(),
isset( $this->request['_embed'] )
);
}
}
return $this->prepare_item( $boxes_data );
}
/**
* Check if a given request has access to a box.
* By default, no special permissions needed, but filtering return value.
*
* @since 2.2.3
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|boolean
*/
public function get_item_permissions_check( $request ) {
$this->initiate_rest_read_box( $request, 'box_read' );
return $this->get_item_permissions_check_filter();
}
/**
* Check by filter if a given request has access to a box.
* By default, no special permissions needed, but filtering return value.
*
* @since 2.2.3
*
* @param bool $can_access Whether the current request has access to view the box by default.
* @return WP_Error|boolean
*/
public function get_item_permissions_check_filter( $can_access = true ) {
/**
* By default, no special permissions needed.
*
* @since 2.2.3
*
* @param bool $can_access Whether this CMB2 endpoint can be accessed.
* @param object $controller This CMB2_REST_Controller object.
*/
return $this->maybe_hook_callback_and_apply_filters( 'cmb2_api_get_box_permissions_check', $can_access );
}
/**
* Get one CMB2 box from the collection.
*
* @since 2.2.3
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|WP_REST_Response
*/
public function get_item( $request ) {
$this->initiate_rest_read_box( $request, 'box_read' );
if ( is_wp_error( $this->rest_box ) ) {
return $this->rest_box;
}
return $this->prepare_item( $this->get_rest_box() );
}
/**
* Get a CMB2 box prepared for REST
*
* @since 2.2.3
*
* @return array
*/
public function get_rest_box() {
$cmb = $this->rest_box->cmb;
$boxes_data = $cmb->meta_box;
if ( isset( $this->request['_rendered'] ) && $this->namespace_base !== ltrim( CMB2_REST_Controller::get_intial_route(), '/' ) ) {
$boxes_data['form_open'] = $this->get_cb_results( array( $cmb, 'render_form_open' ) );
$boxes_data['form_close'] = $this->get_cb_results( array( $cmb, 'render_form_close' ) );
global $wp_scripts, $wp_styles;
$before_css = $wp_styles->queue;
$before_js = $wp_scripts->queue;
CMB2_JS::enqueue();
$boxes_data['js_dependencies'] = array_values( array_diff( $wp_scripts->queue, $before_js ) );
$boxes_data['css_dependencies'] = array_values( array_diff( $wp_styles->queue, $before_css ) );
}
// TODO: look into 'embed' parameter.
// http://demo.wp-api.org/wp-json/wp/v2/posts?_embed
unset( $boxes_data['fields'] );
// Handle callable properties.
unset( $boxes_data['show_on_cb'] );
$response = rest_ensure_response( $boxes_data );
$response->add_links( $this->prepare_links( $cmb ) );
return $response;
}
/**
* Return an array of contextual links for box/boxes.
*
* @since 2.2.3
*
* @param CMB2_REST $cmb CMB2_REST object to build links from.
*
* @return array Array of links
*/
protected function prepare_links( $cmb ) {
$boxbase = $this->namespace_base . '/' . $cmb->cmb_id;
$query_string = $this->get_query_string();
return array(
// Standard Link Relations -- http://v2.wp-api.org/extending/linking/
'self' => array(
'href' => rest_url( $boxbase . $query_string ),
),
'collection' => array(
'href' => rest_url( $this->namespace_base . $query_string ),
),
// Custom Link Relations -- http://v2.wp-api.org/extending/linking/
// TODO URL should document relationship.
'https://cmb2.io/fields' => array(
'href' => rest_url( trailingslashit( $boxbase ) . 'fields' . $query_string ),
'embeddable' => true,
),
);
}
}

View File

@ -0,0 +1,534 @@
<?php
/**
* CMB2 objects/fields endpoint for WordPres REST API.
* Allows access to fields registered to a specific box.
*
* @todo Add better documentation.
* @todo Research proper schema.
*
* @since 2.2.3
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_REST_Controller_Fields extends CMB2_REST_Controller_Boxes {
/**
* Register the routes for the objects of the controller.
*
* @since 2.2.3
*/
public function register_routes() {
$args = array(
'_embed' => array(
'description' => __( 'Includes the box object which the fields are registered to in the response.', 'cmb2' ),
),
'_rendered' => array(
'description' => __( 'When the \'_rendered\' argument is passed, the renderable field attributes will be returned fully rendered. By default, the names of the callback handers for the renderable attributes will be returned.', 'cmb2' ),
),
'object_id' => array(
'description' => __( 'To view or modify the field\'s value, the \'object_id\' and \'object_type\' arguments are required.', 'cmb2' ),
),
'object_type' => array(
'description' => __( 'To view or modify the field\'s value, the \'object_id\' and \'object_type\' arguments are required.', 'cmb2' ),
),
);
// Returns specific box's fields.
register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<cmb_id>[\w-]+)/fields/', array(
array(
'methods' => WP_REST_Server::READABLE,
'permission_callback' => array( $this, 'get_items_permissions_check' ),
'callback' => array( $this, 'get_items' ),
'args' => $args,
),
'schema' => array( $this, 'get_item_schema' ),
) );
$delete_args = $args;
$delete_args['object_id']['required'] = true;
$delete_args['object_type']['required'] = true;
// Returns specific field data.
register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<cmb_id>[\w-]+)/fields/(?P<field_id>[\w-]+)', array(
array(
'methods' => WP_REST_Server::READABLE,
'permission_callback' => array( $this, 'get_item_permissions_check' ),
'callback' => array( $this, 'get_item' ),
'args' => $args,
),
array(
'methods' => WP_REST_Server::EDITABLE,
'permission_callback' => array( $this, 'update_item_permissions_check' ),
'callback' => array( $this, 'update_item' ),
'args' => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
'args' => $args,
),
array(
'methods' => WP_REST_Server::DELETABLE,
'permission_callback' => array( $this, 'delete_item_permissions_check' ),
'callback' => array( $this, 'delete_item' ),
'args' => $delete_args,
),
'schema' => array( $this, 'get_item_schema' ),
) );
}
/**
* Check if a given request has access to get fields.
* By default, no special permissions needed, but filtering return value.
*
* @since 2.2.3
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|boolean
*/
public function get_items_permissions_check( $request ) {
$this->initiate_rest_read_box( $request, 'fields_read' );
$can_access = true;
/**
* By default, no special permissions needed.
*
* @since 2.2.3
*
* @param bool $can_access Whether this CMB2 endpoint can be accessed.
* @param object $controller This CMB2_REST_Controller object.
*/
return $this->maybe_hook_callback_and_apply_filters( 'cmb2_api_get_fields_permissions_check', $can_access );
}
/**
* Get all public CMB2 box fields.
*
* @since 2.2.3
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|WP_REST_Response
*/
public function get_items( $request ) {
if ( ! $this->rest_box ) {
$this->initiate_rest_read_box( $request, 'fields_read' );
}
if ( is_wp_error( $this->rest_box ) ) {
return $this->rest_box;
}
$fields = array();
foreach ( $this->rest_box->cmb->prop( 'fields', array() ) as $field ) {
// Make sure this field can be read.
$this->field = $this->rest_box->field_can_read( $field['id'], true );
// And make sure current user can view this box.
if ( $this->field && $this->get_item_permissions_check_filter() ) {
$fields[ $field['id'] ] = $this->server->response_to_data(
$this->prepare_field_response(),
isset( $this->request['_embed'] )
);
}
}
return $this->prepare_item( $fields );
}
/**
* Check if a given request has access to a field.
* By default, no special permissions needed, but filtering return value.
*
* @since 2.2.3
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|boolean
*/
public function get_item_permissions_check( $request ) {
$this->initiate_rest_read_box( $request, 'field_read' );
if ( ! is_wp_error( $this->rest_box ) ) {
$this->field = $this->rest_box->field_can_read( $this->request->get_param( 'field_id' ), true );
}
return $this->get_item_permissions_check_filter();
}
/**
* Check by filter if a given request has access to a field.
* By default, no special permissions needed, but filtering return value.
*
* @since 2.2.3
*
* @param bool $can_access Whether the current request has access to view the field by default.
* @return WP_Error|boolean
*/
public function get_item_permissions_check_filter( $can_access = true ) {
/**
* By default, no special permissions needed.
*
* @since 2.2.3
*
* @param bool $can_access Whether this CMB2 endpoint can be accessed.
* @param object $controller This CMB2_REST_Controller object.
*/
return $this->maybe_hook_callback_and_apply_filters( 'cmb2_api_get_field_permissions_check', $can_access );
}
/**
* Get one CMB2 field from the collection.
*
* @since 2.2.3
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|WP_REST_Response
*/
public function get_item( $request ) {
$this->initiate_rest_read_box( $request, 'field_read' );
if ( is_wp_error( $this->rest_box ) ) {
return $this->rest_box;
}
return $this->prepare_read_field( $this->request->get_param( 'field_id' ) );
}
/**
* Check if a given request has access to update a field value.
* By default, requires 'edit_others_posts' capability, but filtering return value.
*
* @since 2.2.3
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|boolean
*/
public function update_item_permissions_check( $request ) {
$this->initiate_rest_read_box( $request, 'field_value_update' );
if ( ! is_wp_error( $this->rest_box ) ) {
$this->field = $this->rest_box->field_can_edit( $this->request->get_param( 'field_id' ), true );
}
$can_update = current_user_can( 'edit_others_posts' );
/**
* By default, 'edit_others_posts' is required capability.
*
* @since 2.2.3
*
* @param bool $can_update Whether this CMB2 endpoint can be accessed.
* @param object $controller This CMB2_REST_Controller object.
*/
return $this->maybe_hook_callback_and_apply_filters( 'cmb2_api_update_field_value_permissions_check', $can_update );
}
/**
* Update CMB2 field value.
*
* @since 2.2.3
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|WP_REST_Response
*/
public function update_item( $request ) {
$this->initiate_rest_read_box( $request, 'field_value_update' );
if ( ! $this->request['value'] ) {
return new WP_Error( 'cmb2_rest_update_field_error', __( 'CMB2 Field value cannot be updated without the value parameter specified.', 'cmb2' ), array(
'status' => 400,
) );
}
return $this->modify_field_value( 'updated' );
}
/**
* Check if a given request has access to delete a field value.
* By default, requires 'delete_others_posts' capability, but filtering return value.
*
* @since 2.2.3
*
* @param WP_REST_Request $request Full details about the request.
* @return WP_Error|boolean
*/
public function delete_item_permissions_check( $request ) {
$this->initiate_rest_read_box( $request, 'field_value_delete' );
if ( ! is_wp_error( $this->rest_box ) ) {
$this->field = $this->rest_box->field_can_edit( $this->request->get_param( 'field_id' ), true );
}
$can_delete = current_user_can( 'delete_others_posts' );
/**
* By default, 'delete_others_posts' is required capability.
*
* @since 2.2.3
*
* @param bool $can_delete Whether this CMB2 endpoint can be accessed.
* @param object $controller This CMB2_REST_Controller object.
*/
return $this->maybe_hook_callback_and_apply_filters( 'cmb2_api_delete_field_value_permissions_check', $can_delete );
}
/**
* Delete CMB2 field value.
*
* @since 2.2.3
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|WP_REST_Response
*/
public function delete_item( $request ) {
$this->initiate_rest_read_box( $request, 'field_value_delete' );
return $this->modify_field_value( 'deleted' );
}
/**
* Modify CMB2 field value.
*
* @since 2.2.3
*
* @param string $activity The modification activity (updated or deleted).
* @return WP_Error|WP_REST_Response
*/
public function modify_field_value( $activity ) {
if ( ! $this->request['object_id'] || ! $this->request['object_type'] ) {
return new WP_Error( 'cmb2_rest_modify_field_value_error', __( 'CMB2 Field value cannot be modified without the object_id and object_type parameters specified.', 'cmb2' ), array(
'status' => 400,
) );
}
if ( is_wp_error( $this->rest_box ) ) {
return $this->rest_box;
}
$this->field = $this->rest_box->field_can_edit(
$this->field ? $this->field : $this->request->get_param( 'field_id' ),
true
);
if ( ! $this->field ) {
return new WP_Error( 'cmb2_rest_no_field_by_id_error', __( 'No field found by that id.', 'cmb2' ), array(
'status' => 403,
) );
}
$this->field->args[ "value_{$activity}" ] = (bool) 'deleted' === $activity
? $this->field->remove_data()
: $this->field->save_field( $this->request['value'] );
// If options page, save the $activity options
if ( 'options-page' == $this->request['object_type'] ) {
$this->field->args[ "value_{$activity}" ] = cmb2_options( $this->request['object_id'] )->set();
}
return $this->prepare_read_field( $this->field );
}
/**
* Get a response object for a specific field ID.
*
* @since 2.2.3
*
* @param string\CMB2_Field Field id or Field object.
* @return WP_Error|WP_REST_Response
*/
public function prepare_read_field( $field ) {
$this->field = $this->rest_box->field_can_read( $field, true );
if ( ! $this->field ) {
return new WP_Error( 'cmb2_rest_no_field_by_id_error', __( 'No field found by that id.', 'cmb2' ), array(
'status' => 403,
) );
}
return $this->prepare_item( $this->prepare_field_response() );
}
/**
* Get a specific field response.
*
* @since 2.2.3
*
* @param CMB2_Field Field object.
* @return array Response array.
*/
public function prepare_field_response() {
$field_data = $this->prepare_field_data( $this->field );
$response = rest_ensure_response( $field_data );
$response->add_links( $this->prepare_links( $this->field ) );
return $response;
}
/**
* Prepare the field data array for JSON.
*
* @since 2.2.3
*
* @param CMB2_Field $field field object.
*
* @return array Array of field data.
*/
protected function prepare_field_data( CMB2_Field $field ) {
$field_data = array();
$params_to_ignore = array( 'show_in_rest', 'options' );
$params_to_rename = array(
'label_cb' => 'label',
'options_cb' => 'options',
);
// Run this first so the js_dependencies arg is populated.
$rendered = ( $cb = $field->maybe_callback( 'render_row_cb' ) )
// Ok, callback is good, let's run it.
? $this->get_cb_results( $cb, $field->args(), $field )
: false;
$field_args = $field->args();
foreach ( $field_args as $key => $value ) {
if ( in_array( $key, $params_to_ignore, true ) ) {
continue;
}
if ( 'options_cb' === $key ) {
$value = $field->options();
} elseif ( in_array( $key, CMB2_Field::$callable_fields, true ) ) {
if ( isset( $this->request['_rendered'] ) ) {
$value = $key === 'render_row_cb' ? $rendered : $field->get_param_callback_result( $key );
} elseif ( is_array( $value ) ) {
// We need to rewrite callbacks as string as they will cause
// JSON recursion errors.
$class = is_string( $value[0] ) ? $value[0] : get_class( $value[0] );
$value = $class . '::' . $value[1];
}
}
$key = isset( $params_to_rename[ $key ] ) ? $params_to_rename[ $key ] : $key;
if ( empty( $value ) || is_scalar( $value ) || is_array( $value ) ) {
$field_data[ $key ] = $value;
} else {
$field_data[ $key ] = sprintf( __( 'Value Error for %s', 'cmb2' ), $key );
}
}
if ( $field->args( 'has_supporting_data' ) ) {
$field_data = $this->get_supporting_data( $field_data, $field );
}
if ( $this->request['object_id'] && $this->request['object_type'] ) {
$field_data['value'] = $field->get_rest_value();
}
return $field_data;
}
/**
* Gets field supporting data (field id and value).
*
* @since 2.7.0
*
* @param CMB2_Field $field Field object.
* @param array $field_data Array of field data.
*
* @return array Array of field data.
*/
public function get_supporting_data( $field_data, $field ) {
// Reset placement of this property.
unset( $field_data['has_supporting_data'] );
$field_data['has_supporting_data'] = true;
$field = $field->get_supporting_field();
$field_data['supporting_data'] = array(
'id' => $field->_id( '', false ),
);
if ( $this->request['object_id'] && $this->request['object_type'] ) {
$field_data['supporting_data']['value'] = $field->get_rest_value();
}
return $field_data;
}
/**
* Return an array of contextual links for field/fields.
*
* @since 2.2.3
*
* @param CMB2_Field $field Field object to build links from.
*
* @return array Array of links
*/
protected function prepare_links( $field ) {
$boxbase = $this->namespace_base . '/' . $this->rest_box->cmb->cmb_id;
$query_string = $this->get_query_string();
$links = array(
'self' => array(
'href' => rest_url( trailingslashit( $boxbase ) . 'fields/' . $field->_id( '', false ) . $query_string ),
),
'collection' => array(
'href' => rest_url( trailingslashit( $boxbase ) . 'fields' . $query_string ),
),
'up' => array(
'embeddable' => true,
'href' => rest_url( $boxbase . $query_string ),
),
);
return $links;
}
/**
* Checks if the CMB2 box or field has any registered callback parameters for the given filter.
*
* The registered handlers will have a property name which matches the filter, except:
* - The 'cmb2_api' prefix will be removed
* - A '_cb' suffix will be added (to stay inline with other '*_cb' parameters).
*
* @since 2.2.3
*
* @param string $filter The filter name.
* @param bool $default_val The default filter value.
*
* @return bool The possibly-modified filter value (if the _cb param is a non-callable).
*/
public function maybe_hook_registered_callback( $filter, $default_val ) {
$default_val = parent::maybe_hook_registered_callback( $filter, $default_val );
if ( $this->field ) {
// Hook field specific filter callbacks.
$val = $this->field->maybe_hook_parameter( $filter, $default_val );
if ( null !== $val ) {
$default_val = $val;
}
}
return $default_val;
}
/**
* Unhooks any CMB2 box or field registered callback parameters for the given filter.
*
* @since 2.2.3
*
* @param string $filter The filter name.
*
* @return void
*/
public function maybe_unhook_registered_callback( $filter ) {
parent::maybe_unhook_registered_callback( $filter );
if ( $this->field ) {
// Unhook field specific filter callbacks.
$this->field->maybe_hook_parameter( $filter, null, 'remove_filter' );
}
}
}

View File

@ -0,0 +1,541 @@
<?php
abstract class WP_REST_Controller {
/**
* The namespace of this controller's route.
*
* @var string
*/
protected $namespace;
/**
* The base of this controller's route.
*
* @var string
*/
protected $rest_base;
/**
* Register the routes for the objects of the controller.
*/
public function register_routes() {
/* translators: %s: register_routes() */
_doing_it_wrong( 'WP_REST_Controller::register_routes', sprintf( __( "Method '%s' must be overridden." ), __METHOD__ ), '4.7' );
}
/**
* Check if a given request has access to get items.
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|boolean
*/
public function get_items_permissions_check( $request ) {
return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array(
'status' => 405,
) );
}
/**
* Get a collection of items.
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|WP_REST_Response
*/
public function get_items( $request ) {
return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array(
'status' => 405,
) );
}
/**
* Check if a given request has access to get a specific item.
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|boolean
*/
public function get_item_permissions_check( $request ) {
return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array(
'status' => 405,
) );
}
/**
* Get one item from the collection.
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|WP_REST_Response
*/
public function get_item( $request ) {
return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array(
'status' => 405,
) );
}
/**
* Check if a given request has access to create items.
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|boolean
*/
public function create_item_permissions_check( $request ) {
return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array(
'status' => 405,
) );
}
/**
* Create one item from the collection.
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|WP_REST_Response
*/
public function create_item( $request ) {
return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array(
'status' => 405,
) );
}
/**
* Check if a given request has access to update a specific item.
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|boolean
*/
public function update_item_permissions_check( $request ) {
return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array(
'status' => 405,
) );
}
/**
* Update one item from the collection.
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|WP_REST_Response
*/
public function update_item( $request ) {
return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array(
'status' => 405,
) );
}
/**
* Check if a given request has access to delete a specific item.
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|boolean
*/
public function delete_item_permissions_check( $request ) {
return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array(
'status' => 405,
) );
}
/**
* Delete one item from the collection.
*
* @param WP_REST_Request $request Full data about the request.
* @return WP_Error|WP_REST_Response
*/
public function delete_item( $request ) {
return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array(
'status' => 405,
) );
}
/**
* Prepare the item for create or update operation.
*
* @param WP_REST_Request $request Request object.
* @return WP_Error|object $prepared_item
*/
protected function prepare_item_for_database( $request ) {
return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array(
'status' => 405,
) );
}
/**
* Prepare the item for the REST response.
*
* @param mixed $item WordPress representation of the item.
* @param WP_REST_Request $request Request object.
* @return WP_REST_Response $response
*/
public function prepare_item_for_response( $item, $request ) {
return new WP_Error( 'invalid-method', sprintf( __( "Method '%s' not implemented. Must be overridden in subclass." ), __METHOD__ ), array(
'status' => 405,
) );
}
/**
* Prepare a response for inserting into a collection.
*
* @param WP_REST_Response $response Response object.
* @return array Response data, ready for insertion into collection data.
*/
public function prepare_response_for_collection( $response ) {
if ( ! ( $response instanceof WP_REST_Response ) ) {
return $response;
}
$data = (array) $response->get_data();
$server = rest_get_server();
if ( method_exists( $server, 'get_compact_response_links' ) ) {
$links = call_user_func( array( $server, 'get_compact_response_links' ), $response );
} else {
$links = call_user_func( array( $server, 'get_response_links' ), $response );
}
if ( ! empty( $links ) ) {
$data['_links'] = $links;
}
return $data;
}
/**
* Filter a response based on the context defined in the schema.
*
* @param array $data
* @param string $context
* @return array
*/
public function filter_response_by_context( $data, $context ) {
$schema = $this->get_item_schema();
foreach ( $data as $key => $value ) {
if ( empty( $schema['properties'][ $key ] ) || empty( $schema['properties'][ $key ]['context'] ) ) {
continue;
}
if ( ! in_array( $context, $schema['properties'][ $key ]['context'] ) ) {
unset( $data[ $key ] );
continue;
}
if ( 'object' === $schema['properties'][ $key ]['type'] && ! empty( $schema['properties'][ $key ]['properties'] ) ) {
foreach ( $schema['properties'][ $key ]['properties'] as $attribute => $details ) {
if ( empty( $details['context'] ) ) {
continue;
}
if ( ! in_array( $context, $details['context'] ) ) {
if ( isset( $data[ $key ][ $attribute ] ) ) {
unset( $data[ $key ][ $attribute ] );
}
}
}
}
}
return $data;
}
/**
* Get the item's schema, conforming to JSON Schema.
*
* @return array
*/
public function get_item_schema() {
return $this->add_additional_fields_schema( array() );
}
/**
* Get the item's schema for display / public consumption purposes.
*
* @return array
*/
public function get_public_item_schema() {
$schema = $this->get_item_schema();
foreach ( $schema['properties'] as &$property ) {
if ( isset( $property['arg_options'] ) ) {
unset( $property['arg_options'] );
}
}
return $schema;
}
/**
* Get the query params for collections.
*
* @return array
*/
public function get_collection_params() {
return array(
'context' => $this->get_context_param(),
'page' => array(
'description' => __( 'Current page of the collection.' ),
'type' => 'integer',
'default' => 1,
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
'minimum' => 1,
),
'per_page' => array(
'description' => __( 'Maximum number of items to be returned in result set.' ),
'type' => 'integer',
'default' => 10,
'minimum' => 1,
'maximum' => 100,
'sanitize_callback' => 'absint',
'validate_callback' => 'rest_validate_request_arg',
),
'search' => array(
'description' => __( 'Limit results to those matching a string.' ),
'type' => 'string',
'sanitize_callback' => 'sanitize_text_field',
'validate_callback' => 'rest_validate_request_arg',
),
);
}
/**
* Get the magical context param.
*
* Ensures consistent description between endpoints, and populates enum from schema.
*
* @param array $args
* @return array
*/
public function get_context_param( $args = array() ) {
$param_details = array(
'description' => __( 'Scope under which the request is made; determines fields present in response.' ),
'type' => 'string',
'sanitize_callback' => 'sanitize_key',
'validate_callback' => 'rest_validate_request_arg',
);
$schema = $this->get_item_schema();
if ( empty( $schema['properties'] ) ) {
return array_merge( $param_details, $args );
}
$contexts = array();
foreach ( $schema['properties'] as $attributes ) {
if ( ! empty( $attributes['context'] ) ) {
$contexts = array_merge( $contexts, $attributes['context'] );
}
}
if ( ! empty( $contexts ) ) {
$param_details['enum'] = array_unique( $contexts );
rsort( $param_details['enum'] );
}
return array_merge( $param_details, $args );
}
/**
* Add the values from additional fields to a data object.
*
* @param array $object
* @param WP_REST_Request $request
* @return array modified object with additional fields.
*/
protected function add_additional_fields_to_object( $object, $request ) {
$additional_fields = $this->get_additional_fields();
foreach ( $additional_fields as $field_name => $field_options ) {
if ( ! $field_options['get_callback'] ) {
continue;
}
$object[ $field_name ] = call_user_func( $field_options['get_callback'], $object, $field_name, $request, $this->get_object_type() );
}
return $object;
}
/**
* Update the values of additional fields added to a data object.
*
* @param array $object
* @param WP_REST_Request $request
*/
protected function update_additional_fields_for_object( $object, $request ) {
$additional_fields = $this->get_additional_fields();
foreach ( $additional_fields as $field_name => $field_options ) {
if ( ! $field_options['update_callback'] ) {
continue;
}
// Don't run the update callbacks if the data wasn't passed in the request.
if ( ! isset( $request[ $field_name ] ) ) {
continue;
}
call_user_func( $field_options['update_callback'], $request[ $field_name ], $object, $field_name, $request, $this->get_object_type() );
}
}
/**
* Add the schema from additional fields to an schema array.
*
* The type of object is inferred from the passed schema.
*
* @param array $schema Schema array.
*/
protected function add_additional_fields_schema( $schema ) {
if ( empty( $schema['title'] ) ) {
return $schema;
}
/**
* Can't use $this->get_object_type otherwise we cause an inf loop.
*/
$object_type = $schema['title'];
$additional_fields = $this->get_additional_fields( $object_type );
foreach ( $additional_fields as $field_name => $field_options ) {
if ( ! $field_options['schema'] ) {
continue;
}
$schema['properties'][ $field_name ] = $field_options['schema'];
}
return $schema;
}
/**
* Get all the registered additional fields for a given object-type.
*
* @param string $object_type
* @return array
*/
protected function get_additional_fields( $object_type = null ) {
if ( ! $object_type ) {
$object_type = $this->get_object_type();
}
if ( ! $object_type ) {
return array();
}
global $wp_rest_additional_fields;
if ( ! $wp_rest_additional_fields || ! isset( $wp_rest_additional_fields[ $object_type ] ) ) {
return array();
}
return $wp_rest_additional_fields[ $object_type ];
}
/**
* Get the object type this controller is responsible for managing.
*
* @return string
*/
protected function get_object_type() {
$schema = $this->get_item_schema();
if ( ! $schema || ! isset( $schema['title'] ) ) {
return null;
}
return $schema['title'];
}
/**
* Get an array of endpoint arguments from the item schema for the controller.
*
* @param string $method HTTP method of the request. The arguments
* for `CREATABLE` requests are checked for required
* values and may fall-back to a given default, this
* is not done on `EDITABLE` requests. Default is
* WP_REST_Server::CREATABLE.
* @return array $endpoint_args
*/
public function get_endpoint_args_for_item_schema( $method = WP_REST_Server::CREATABLE ) {
$schema = $this->get_item_schema();
$schema_properties = ! empty( $schema['properties'] ) ? $schema['properties'] : array();
$endpoint_args = array();
foreach ( $schema_properties as $field_id => $params ) {
// Arguments specified as `readonly` are not allowed to be set.
if ( ! empty( $params['readonly'] ) ) {
continue;
}
$endpoint_args[ $field_id ] = array(
'validate_callback' => 'rest_validate_request_arg',
'sanitize_callback' => 'rest_sanitize_request_arg',
);
if ( isset( $params['description'] ) ) {
$endpoint_args[ $field_id ]['description'] = $params['description'];
}
if ( WP_REST_Server::CREATABLE === $method && isset( $params['default'] ) ) {
$endpoint_args[ $field_id ]['default'] = $params['default'];
}
if ( WP_REST_Server::CREATABLE === $method && ! empty( $params['required'] ) ) {
$endpoint_args[ $field_id ]['required'] = true;
}
foreach ( array( 'type', 'format', 'enum' ) as $schema_prop ) {
if ( isset( $params[ $schema_prop ] ) ) {
$endpoint_args[ $field_id ][ $schema_prop ] = $params[ $schema_prop ];
}
}
// Merge in any options provided by the schema property.
if ( isset( $params['arg_options'] ) ) {
// Only use required / default from arg_options on CREATABLE endpoints.
if ( WP_REST_Server::CREATABLE !== $method ) {
$params['arg_options'] = array_diff_key( $params['arg_options'], array(
'required' => '',
'default' => '',
) );
}
$endpoint_args[ $field_id ] = array_merge( $endpoint_args[ $field_id ], $params['arg_options'] );
}
}// End foreach().
return $endpoint_args;
}
/**
* Retrieves post data given a post ID or post object.
*
* This is a subset of the functionality of the `get_post()` function, with
* the additional functionality of having `the_post` action done on the
* resultant post object. This is done so that plugins may manipulate the
* post that is used in the REST API.
*
* @see get_post()
* @global WP_Query $wp_query
*
* @param int|WP_Post $post Post ID or post object. Defaults to global $post.
* @return WP_Post|null A `WP_Post` object when successful.
*/
public function get_post( $post ) {
$post_obj = get_post( $post );
/**
* Filter the post.
*
* Allows plugins to filter the post object as returned by `\WP_REST_Controller::get_post()`.
*
* @param WP_Post|null $post_obj The post object as returned by `get_post()`.
* @param int|WP_Post $post The original value used to obtain the post object.
*/
$post = apply_filters( 'rest_the_post', $post_obj, $post );
return $post;
}
}

View File

@ -0,0 +1,177 @@
<?php
/**
* CMB base field type
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
abstract class CMB2_Type_Base {
/**
* The CMB2_Types object
*
* @var CMB2_Types
*/
public $types;
/**
* Arguments for use in the render method
*
* @var array
*/
public $args;
/**
* Rendered output (if 'rendered' argument is set to false)
*
* @var string
*/
protected $rendered = '';
/**
* Constructor
*
* @since 2.2.2
* @param CMB2_Types $types Object for the field type.
* @param array $args Array of arguments for the type.
*/
public function __construct( CMB2_Types $types, $args = array() ) {
$this->types = $types;
$args['rendered'] = isset( $args['rendered'] ) ? (bool) $args['rendered'] : true;
$this->args = $args;
}
/**
* Handles rendering this field type.
*
* @since 2.2.2
* @return string Rendered field type.
*/
abstract public function render();
/**
* Stores the rendered field output.
*
* @since 2.2.2
* @param string|CMB2_Type_Base $rendered Rendered output.
* @return string|CMB2_Type_Base Rendered output or this object.
*/
public function rendered( $rendered ) {
$this->field->register_js_data();
if ( $this->args['rendered'] ) {
return is_a( $rendered, __CLASS__ ) ? $rendered->rendered : $rendered;
}
$this->rendered = is_a( $rendered, __CLASS__ ) ? $rendered->rendered : $rendered;
return $this;
}
/**
* Returns the stored rendered field output.
*
* @since 2.2.2
* @return string Stored rendered output (if 'rendered' argument is set to false).
*/
public function get_rendered() {
return $this->rendered;
}
/**
* Handles parsing and filtering attributes while preserving any passed in via field config.
*
* @since 1.1.0
* @param string $element Element for filter.
* @param array $type_defaults Type default arguments.
* @param array $type_overrides Type override arguments.
* @return array Parsed and filtered arguments.
*/
public function parse_args( $element, $type_defaults, $type_overrides = array() ) {
$args = $this->parse_args_from_overrides( $type_overrides );
/**
* Filter attributes for a field type.
* The dynamic portion of the hook name, $element, refers to the field type.
*
* @since 1.1.0
* @param array $args The array of attribute arguments.
* @param array $type_defaults The array of default values.
* @param array $field The `CMB2_Field` object.
* @param object $field_type_object This `CMB2_Types` object.
*/
$args = apply_filters( "cmb2_{$element}_attributes", $args, $type_defaults, $this->field, $this->types );
$args = wp_parse_args( $args, $type_defaults );
if ( ! empty( $args['js_dependencies'] ) ) {
$this->field->add_js_dependencies( $args['js_dependencies'] );
}
return $args;
}
/**
* Handles parsing and filtering attributes while preserving any passed in via field config.
*
* @since 2.2.4
* @param array $type_overrides Type override arguments.
* @return array Parsed arguments
*/
protected function parse_args_from_overrides( $type_overrides = array() ) {
$type_overrides = empty( $type_overrides ) ? $this->args : $type_overrides;
if ( true !== $this->field->args( 'disable_hash_data_attribute' ) ) {
$type_overrides['data-hash'] = $this->field->hash_id();
}
$field_overrides = $this->field->args( 'attributes' );
return ! empty( $field_overrides )
? wp_parse_args( $field_overrides, $type_overrides )
: $type_overrides;
}
/**
* Fall back to CMB2_Types methods
*
* @param string $method Method name being invoked.
* @param array $arguments Arguments passed for the method.
* @throws Exception Throws an exception if the field is invalid.
* @return mixed
*/
public function __call( $method, $arguments ) {
switch ( $method ) {
case '_id':
case '_name':
case '_desc':
case '_text':
case 'concat_attrs':
return call_user_func_array( array( $this->types, $method ), $arguments );
default:
throw new Exception( sprintf( esc_html__( 'Invalid %1$s method: %2$s', 'cmb2' ), __CLASS__, $method ) );
}
}
/**
* Magic getter for our object.
*
* @param string $field Property being requested.
* @throws Exception Throws an exception if the field is invalid.
* @return mixed
*/
public function __get( $field ) {
switch ( $field ) {
case 'field':
return $this->types->field;
default:
throw new Exception( sprintf( esc_html__( 'Invalid %1$s property: %2$s', 'cmb2' ), __CLASS__, $field ) );
}
}
}

View File

@ -0,0 +1,74 @@
<?php
/**
* CMB checkbox field type
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Type_Checkbox extends CMB2_Type_Text {
/**
* If checkbox is checked
*
* @var mixed
*/
public $is_checked = null;
/**
* Constructor
*
* @since 2.2.2
*
* @param CMB2_Types $types Object for the field type.
* @param array $args Array of arguments for the type.
* @param mixed $is_checked Whether or not the field is checked, or default value.
*/
public function __construct( CMB2_Types $types, $args = array(), $is_checked = null ) {
parent::__construct( $types, $args );
$this->is_checked = $is_checked;
}
/**
* Render the field for the field type.
*
* @since 2.2.2
*
* @param array $args Array of arguments for the rendering.
* @return CMB2_Type_Base|string
*/
public function render( $args = array() ) {
$defaults = array(
'type' => 'checkbox',
'class' => 'cmb2-option cmb2-list',
'value' => 'on',
'desc' => '',
);
$meta_value = $this->field->escaped_value();
$is_checked = null === $this->is_checked
? ! empty( $meta_value )
: $this->is_checked;
if ( $is_checked ) {
$defaults['checked'] = 'checked';
}
$args = $this->parse_args( 'checkbox', $defaults );
return $this->rendered(
sprintf(
'%s <label for="%s">%s</label>',
parent::render( $args ),
$this->_id( '', false ),
$this->_desc()
)
);
}
}

View File

@ -0,0 +1,120 @@
<?php
/**
* CMB colorpicker field type
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Type_Colorpicker extends CMB2_Type_Text {
/**
* The optional value for the colorpicker field
*
* @var string
*/
public $value = '';
/**
* Constructor
*
* @since 2.2.2
*
* @param CMB2_Types $types Object for the field type.
* @param array $args Array of arguments for the type.
* @param string $value Value that the field type is currently set to, or default value.
*/
public function __construct( CMB2_Types $types, $args = array(), $value = '' ) {
parent::__construct( $types, $args );
$this->value = $value ? $value : $this->value;
}
/**
* Render the field for the field type.
*
* @since 2.2.2
*
* @param array $args Array of arguments for the rendering.
*
* @return CMB2_Type_Base|string
*/
public function render( $args = array() ) {
$meta_value = $this->value ? $this->value : $this->field->escaped_value();
$meta_value = self::sanitize_color( $meta_value );
wp_enqueue_style( 'wp-color-picker' );
$args = wp_parse_args( $args, array(
'class' => 'cmb2-text-small',
) );
$args['class'] .= ' cmb2-colorpicker';
$args['value'] = $meta_value;
$args['js_dependencies'] = array( 'wp-color-picker' );
if ( $this->field->options( 'alpha' ) ) {
$args['js_dependencies'][] = 'wp-color-picker-alpha';
$args['data-alpha'] = 'true';
}
$args = wp_parse_args( $this->args, $args );
return parent::render( $args );
}
/**
* Sanitizes the given color, or array of colors.
*
* @since 2.9.0
*
* @param string|array $color The color or array of colors to sanitize.
*
* @return string|array The color or array of colors, sanitized.
*/
public static function sanitize_color( $color ) {
if ( is_array( $color ) ) {
$color = array_map( array( 'CMB2_Type_Colorpicker', 'sanitize_color' ), $color );
} else {
// Regexp for hexadecimal colors
$hex_color = '(([a-fA-F0-9]){3}){1,2}$';
if ( preg_match( '/^' . $hex_color . '/i', $color ) ) {
// Value is just 123abc, so prepend #
$color = '#' . $color;
} elseif (
// If value doesn't match #123abc...
! preg_match( '/^#' . $hex_color . '/i', $color )
// And value doesn't match rgba()...
&& 0 !== strpos( trim( $color ), 'rgba' )
) {
// Then sanitize to just #.
$color = '#';
}
}
return $color;
}
/**
* Provide the option to use a rgba colorpicker.
*
* @since 2.2.6.2
*/
public static function dequeue_rgba_colorpicker_script() {
if ( wp_script_is( 'jw-cmb2-rgba-picker-js', 'enqueued' ) ) {
wp_dequeue_script( 'jw-cmb2-rgba-picker-js' );
CMB2_JS::register_colorpicker_alpha( true );
}
}
}

View File

@ -0,0 +1,138 @@
<?php
/**
* CMB base field type
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
abstract class CMB2_Type_Counter_Base extends CMB2_Type_Base {
/**
* Whether this type has the counter added.
*
* @since 2.7.0
*
* @var boolean
*/
public $has_counter = false;
/**
* Return character counter markup for this field.
*
* @since 2.7.0
*
* @param string $val The actual value of this field.
*
* @return string
*/
public function char_counter_markup( $val ) {
$markup = '';
if ( ! $this->field->args( 'char_counter' ) ) {
return $markup;
}
$type = (string) $this->field->args( 'char_counter' );
$field_id = $this->_id( '', false );
$char_max = (int) $this->field->prop( 'char_max' );
if ( $char_max ) {
$char_max = 'data-max="' . $char_max . '"';
}
switch ( $type ) {
case 'words':
$label = $char_max
? $this->_text( 'words_left_text', esc_html__( 'Words left', 'cmb2' ) )
: $this->_text( 'words_text', esc_html__( 'Words', 'cmb2' ) );
break;
default:
$type = 'characters';
$label = $char_max
? $this->_text( 'characters_left_text', esc_html__( 'Characters left', 'cmb2' ) )
: $this->_text( 'characters_text', esc_html__( 'Characters', 'cmb2' ) );
break;
}
$msg = $char_max
? sprintf( '<span class="cmb2-char-max-msg">%s</span>', $this->_text( 'characters_truncated_text', esc_html__( 'Your text may be truncated.', 'cmb2' ) ) )
: '';
$length = strlen( $val );
$width = $length > 1 ? ( 8 * strlen( (string) $length ) ) + 15 : false;
$markup .= '<p class="cmb2-char-counter-wrap">';
$markup .= sprintf(
'<label><span class="cmb2-char-counter-label">%2$s:</span> <input id="%1$s" data-field-id="%3$s" data-counter-type="%4$s" %5$s class="cmb2-char-counter" type="text" value="%6$s" readonly="readonly" style="%7$s"></label>%8$s',
esc_attr( 'char-counter-' . $field_id ),
$label,
esc_attr( $field_id ),
$type,
$char_max,
$length,
$width ? "width: {$width}px;" : '',
$msg
);
$markup .= '</p>';
// Enqueue the required JS.
$this->field->add_js_dependencies( array(
'word-count',
'wp-util',
'cmb2-char-counter',
) );
$this->has_counter = true;
return $markup;
}
/**
* Maybe update attributes for the character counter.
*
* @since 2.7.0
*
* @param array $attributes Array of parsed attributes.
*
* @return array Potentially modified attributes.
*/
public function maybe_update_attributes_for_char_counter( $attributes ) {
$char_counter = $this->char_counter_markup( $attributes['value'] );
// Has character counter?
if ( $char_counter ) {
$attributes['class'] = ! empty( $attributes['class'] ) ? $attributes['class'] . ' cmb2-count-chars' : ' cmb2-count-chars';
// Enforce max chars?
$max = $this->enforce_max();
if ( $max ) {
$attributes['maxlength'] = $max;
}
$attributes['desc'] = $char_counter . $attributes['desc'];
}
return $attributes;
}
/**
* Enforce max chars?
*
* @since 2.7.0
*
* @return bool Whether to enforce max characters.
*/
public function enforce_max() {
$char_max = (int) $this->field->args( 'char_max' );
// Enforce max chars?
return ( $this->field->args( 'char_max_enforce' ) && $char_max > 0
&& 'words' !== $this->field->args( 'char_counter' ) )
? $char_max
: false;
}
}

View File

@ -0,0 +1,190 @@
<?php
/**
* CMB file field type
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Type_File extends CMB2_Type_File_Base {
/**
* Handles outputting an 'file' field
*
* @param array $args Override arguments.
* @return string Form input element
*/
public function render( $args = array() ) {
$args = empty( $args ) ? $this->args : $args;
$field = $this->field;
$options = (array) $field->options();
$a = $this->args = $this->parse_args( 'file', array(
'class' => 'cmb2-upload-file regular-text',
'id' => $this->_id(),
'name' => $this->_name(),
'value' => $field->escaped_value(),
'id_value' => null,
'desc' => $this->_desc( true ),
'size' => 45,
'js_dependencies' => 'media-editor',
'preview_size' => $field->args( 'preview_size' ),
'query_args' => $field->args( 'query_args' ),
// if options array and 'url' => false, then hide the url field.
'type' => array_key_exists( 'url', $options ) && false === $options['url']
? 'hidden'
: 'text',
), $args );
// get an array of image size meta data, fallback to 'large'.
$this->args['img_size_data'] = $img_size_data = parent::get_image_size_data(
$a['preview_size'],
'large'
);
$output = '';
$output .= parent::render( array(
'type' => $a['type'],
'class' => $a['class'],
'value' => $a['value'],
'id' => $a['id'],
'name' => $a['name'],
'size' => $a['size'],
'desc' => '',
'data-previewsize' => sprintf( '[%d,%d]', $img_size_data['width'], $img_size_data['height'] ),
'data-sizename' => $img_size_data['name'],
'data-queryargs' => ! empty( $a['query_args'] ) ? json_encode( $a['query_args'] ) : '',
'js_dependencies' => $a['js_dependencies'],
) );
// Now remove the data-iterator attribute if it exists.
// (Possible if being used within a custom field)
// This is not elegant, but compensates for CMB2_Types::_id
// automagically & inelegantly adding the data-iterator attribute.
// Single responsibility principle? pffft.
$parts = explode( '"', $this->args['id'] );
$this->args['id'] = $parts[0];
$output .= sprintf(
'<input class="cmb2-upload-button button-secondary" type="button" value="%1$s" />',
esc_attr( $this->_text( 'add_upload_file_text', esc_html__( 'Add or Upload File', 'cmb2' ) ) )
);
$output .= $a['desc'];
$output .= $this->get_id_field_output();
$output .= '<div id="' . esc_attr( $field->id() ) . '-status" class="cmb2-media-status">';
if ( ! empty( $a['value'] ) ) {
$output .= $this->get_file_preview_output();
}
$output .= '</div>';
return $this->rendered( $output );
}
/**
* Return attempted file preview output for a provided file.
*
* @since 2.2.5
*
* @return string
*/
public function get_file_preview_output() {
if ( ! $this->is_valid_img_ext( $this->args['value'] ) ) {
return $this->file_status_output( array(
'value' => $this->args['value'],
'tag' => 'div',
'cached_id' => $this->args['id'],
) );
}
if ( $this->args['id_value'] ) {
$image = wp_get_attachment_image( $this->args['id_value'], $this->args['preview_size'], null, array(
'class' => 'cmb-file-field-image',
) );
} else {
$image = '<img style="max-width: ' . absint( $this->args['img_size_data']['width'] ) . 'px; width: 100%;" src="' . esc_url( $this->args['value'] ) . '" class="cmb-file-field-image" alt="" />';
}
return $this->img_status_output( array(
'image' => $image,
'tag' => 'div',
'cached_id' => $this->args['id'],
) );
}
/**
* Return field ID output as a hidden field.
*
* @since 2.2.5
*
* @return string
*/
public function get_id_field_output() {
$field = $this->field;
/*
* A little bit of magic (tsk tsk) replacing the $this->types->field object,
* So that the render function is using the proper field object.
*/
$this->types->field = $this->get_id_field();
$output = parent::render( array(
'type' => 'hidden',
'class' => 'cmb2-upload-file-id',
'value' => $this->types->field->value,
'desc' => '',
) );
// We need to put the original field object back
// or other fields in a custom field will be broken.
$this->types->field = $field;
return $output;
}
/**
* Return field ID data.
*
* @since 2.2.5
*
* @return mixed
*/
public function get_id_field() {
// reset field args for attachment id.
$args = array(
// if we're looking at a file in a group, we need to get the non-prefixed id.
'id' => ( $this->field->group ? $this->field->args( '_id' ) : $this->args['id'] ) . '_id',
'disable_hash_data_attribute' => true,
);
// and get new field object
// (need to set it to the types field property).
$id_field = $this->field->get_field_clone( $args );
$id_value = absint( null !== $this->args['id_value'] ? $this->args['id_value'] : $id_field->escaped_value() );
// we don't want to output "0" as a value.
if ( ! $id_value ) {
$id_value = '';
}
// if there is no id saved yet, try to get it from the url.
if ( $this->args['value'] && ! $id_value ) {
$id_value = CMB2_Utils::image_id_from_url( esc_url_raw( $this->args['value'] ) );
}
$id_field->value = $id_value;
return $id_field;
}
}

View File

@ -0,0 +1,221 @@
<?php
/**
* CMB File base field type
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Type_File_Base extends CMB2_Type_Text {
/**
* Determines if a file has a valid image extension
*
* @since 1.0.0
* @param string $file File url
* @return bool Whether file has a valid image extension
*/
public function is_valid_img_ext( $file, $blah = false ) {
$file_ext = CMB2_Utils::get_file_ext( $file );
$valid_types = array( 'jpg', 'jpeg', 'jpe', 'png', 'gif', 'ico', 'icon' );
$allowed = get_allowed_mime_types();
if ( ! empty( $allowed ) ) {
foreach ( (array) $allowed as $type => $mime) {
if ( 0 === strpos( $mime, 'image/' ) ) {
$types = explode( '|', $type );
$valid_types = array_merge( $valid_types, $types );
}
}
$valid_types = array_unique( $valid_types );
}
/**
* Which image types are considered valid image file extensions.
*
* @since 2.0.9
*
* @param array $valid_types The valid image file extensions.
*/
$is_valid_types = apply_filters( 'cmb2_valid_img_types', $valid_types );
$is_valid = $file_ext && in_array( $file_ext, (array) $is_valid_types );
$field_id = $this->field->id();
/**
* Filter for determining if a field value has a valid image file-type extension.
*
* The dynamic portion of the hook name, $field_id, refers to the field id attribute.
*
* @since 2.0.9
*
* @param bool $is_valid Whether field value has a valid image file-type extension.
* @param string $file File url.
* @param string $file_ext File extension.
*/
return (bool) apply_filters( "cmb2_{$field_id}_is_valid_img_ext", $is_valid, $file, $file_ext );
}
/**
* file/file_list image wrap
*
* @since 2.0.2
* @param array $args Array of arguments for output
* @return string Image wrap output
*/
public function img_status_output( $args ) {
return sprintf( '<%1$s class="img-status cmb2-media-item">%2$s<p class="cmb2-remove-wrapper"><a href="#" class="cmb2-remove-file-button"%3$s>%4$s</a></p>%5$s</%1$s>',
$args['tag'],
$args['image'],
isset( $args['cached_id'] ) ? ' rel="' . esc_attr( $args['cached_id'] ) . '"' : '',
esc_html( $this->_text( 'remove_image_text', esc_html__( 'Remove Image', 'cmb2' ) ) ),
isset( $args['id_input'] ) ? $args['id_input'] : ''
);
}
/**
* file/file_list file wrap
*
* @since 2.0.2
* @param array $args Array of arguments for output
* @return string File wrap output
*/
public function file_status_output( $args ) {
return sprintf( '<%1$s class="file-status cmb2-media-item"><span>%2$s <strong>%3$s</strong></span>&nbsp;&nbsp; (<a href="%4$s" target="_blank" rel="external">%5$s</a> / <a href="#" class="cmb2-remove-file-button"%6$s>%7$s</a>)%8$s</%1$s>',
$args['tag'],
esc_html( $this->_text( 'file_text', esc_html__( 'File:', 'cmb2' ) ) ),
esc_html( CMB2_Utils::get_file_name_from_path( $args['value'] ) ),
esc_url( $args['value'] ),
esc_html( $this->_text( 'file_download_text', esc_html__( 'Download', 'cmb2' ) ) ),
isset( $args['cached_id'] ) ? ' rel="' . esc_attr( $args['cached_id'] ) . '"' : '',
esc_html( $this->_text( 'remove_text', esc_html__( 'Remove', 'cmb2' ) ) ),
isset( $args['id_input'] ) ? $args['id_input'] : ''
);
}
/**
* Outputs the file/file_list underscore Javascript templates in the footer.
*
* @since 2.2.4
* @return void
*/
public static function output_js_underscore_templates() {
?>
<script type="text/html" id="tmpl-cmb2-single-image">
<div class="img-status cmb2-media-item">
<img width="{{ data.sizeWidth }}" height="{{ data.sizeHeight }}" src="{{ data.sizeUrl }}" class="cmb-file-field-image" alt="{{ data.filename }}" title="{{ data.filename }}" />
<p><a href="#" class="cmb2-remove-file-button" rel="{{ data.mediaField }}">{{ data.stringRemoveImage }}</a></p>
</div>
</script>
<script type="text/html" id="tmpl-cmb2-single-file">
<div class="file-status cmb2-media-item">
<span>{{ data.stringFile }} <strong>{{ data.filename }}</strong></span>&nbsp;&nbsp; (<a href="{{ data.url }}" target="_blank" rel="external">{{ data.stringDownload }}</a> / <a href="#" class="cmb2-remove-file-button" rel="{{ data.mediaField }}">{{ data.stringRemoveFile }}</a>)
</div>
</script>
<script type="text/html" id="tmpl-cmb2-list-image">
<li class="img-status cmb2-media-item">
<img width="{{ data.sizeWidth }}" height="{{ data.sizeHeight }}" src="{{ data.sizeUrl }}" class="cmb-file_list-field-image" alt="{{ data.filename }}">
<p><a href="#" class="cmb2-remove-file-button" rel="{{ data.mediaField }}[{{ data.id }}]">{{ data.stringRemoveImage }}</a></p>
<input type="hidden" id="filelist-{{ data.id }}" data-id="{{ data.id }}" name="{{ data.mediaFieldName }}[{{ data.id }}]" value="{{ data.url }}">
</li>
</script>
<script type="text/html" id="tmpl-cmb2-list-file">
<li class="file-status cmb2-media-item">
<span>{{ data.stringFile }} <strong>{{ data.filename }}</strong></span>&nbsp;&nbsp; (<a href="{{ data.url }}" target="_blank" rel="external">{{ data.stringDownload }}</a> / <a href="#" class="cmb2-remove-file-button" rel="{{ data.mediaField }}[{{ data.id }}]">{{ data.stringRemoveFile }}</a>)
<input type="hidden" id="filelist-{{ data.id }}" data-id="{{ data.id }}" name="{{ data.mediaFieldName }}[{{ data.id }}]" value="{{ data.url }}">
</li>
</script>
<?php
}
/**
* Utility method to return an array of meta data for a registered image size
*
* Uses CMB2_Utils::get_named_size() to get the closest available named size
* from an array of width and height values and CMB2_Utils::get_available_image_sizes()
* to get the meta data associated with a named size.
*
* @since 2.2.4
* @param array|string $img_size Image size. Accepts an array of width and height (in that order)
* @param string $fallback Size to use if the supplied named size doesn't exist
* @return array Array containing the image size meta data
* $size = (
* 'width' => (int) image size width
* 'height' => (int) image size height
* 'name' => (string) e.g. 'thumbnail'
* )
*/
static function get_image_size_data( $img_size = '', $fallback = 'thumbnail' ) {
$data = array();
if ( is_array( $img_size ) ) {
$data['width'] = intval( $img_size[0] );
$data['height'] = intval( $img_size[1] );
$data['name'] = '';
// Try and get the closest named size from our array of dimensions
if ( $named_size = CMB2_Utils::get_named_size( $img_size ) ) {
$data['name'] = $named_size;
}
} else {
$image_sizes = CMB2_Utils::get_available_image_sizes();
// The 'thumb' alias, which works elsewhere, doesn't work in the wp.media uploader
if ( 'thumb' == $img_size ) {
$img_size = 'thumbnail';
}
// Named size doesn't exist, use $fallback
if ( ! array_key_exists( $img_size, $image_sizes ) ) {
$img_size = $fallback;
}
// Get image dimensions from named sizes
$data['width'] = intval( $image_sizes[ $img_size ]['width'] );
$data['height'] = intval( $image_sizes[ $img_size ]['height'] );
$data['name'] = $img_size;
}
return $data;
}
/**
* Filters attachment data prepared for JavaScript.
*
* Adds the url, width, height, and orientation for custom sizes to the JavaScript
* object returned by the wp.media uploader. Hooked to 'wp_prepare_attachment_for_js'.
*
* @since 2.2.4
* @param array $response Array of prepared attachment data
* @param int|object $attachment Attachment ID or object
* @param array $meta Array of attachment meta data ( from wp_get_attachment_metadata() )
* @return array filtered $response array
*/
public static function prepare_image_sizes_for_js( $response, $attachment, $meta ) {
foreach ( CMB2_Utils::get_available_image_sizes() as $size => $info ) {
// registered image size exists for this attachment
if ( isset( $meta['sizes'][ $size ] ) ) {
$attachment_url = wp_get_attachment_url( $attachment->ID );
$base_url = str_replace( wp_basename( $attachment_url ), '', $attachment_url );
$size_meta = $meta['sizes'][ $size ];
$response['sizes'][ $size ] = array(
'url' => $base_url . $size_meta['file'],
'height' => $size_meta['height'],
'width' => $size_meta['width'],
'orientation' => $size_meta['height'] > $size_meta['width'] ? 'portrait' : 'landscape',
);
}
}
return $response;
}
}

View File

@ -0,0 +1,86 @@
<?php
/**
* CMB file_list field type
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Type_File_List extends CMB2_Type_File_Base {
public function render( $args = array() ) {
$field = $this->field;
$meta_value = $field->escaped_value();
$name = $this->_name();
$img_size = $field->args( 'preview_size' );
$query_args = $field->args( 'query_args' );
$output = '';
// get an array of image size meta data, fallback to 'thumbnail'
$img_size_data = parent::get_image_size_data( $img_size, 'thumbnail' );
$output .= parent::render( array(
'type' => 'hidden',
'class' => 'cmb2-upload-file cmb2-upload-list',
'size' => 45,
'desc' => '',
'value' => '',
'data-previewsize' => sprintf( '[%d,%d]', $img_size_data['width'], $img_size_data['height'] ),
'data-sizename' => $img_size_data['name'],
'data-queryargs' => ! empty( $query_args ) ? json_encode( $query_args ) : '',
'js_dependencies' => 'media-editor',
) );
$output .= parent::render( array(
'type' => 'button',
'class' => 'cmb2-upload-button button-secondary cmb2-upload-list',
'value' => esc_attr( $this->_text( 'add_upload_files_text', esc_html__( 'Add or Upload Files', 'cmb2' ) ) ),
'name' => false,
'id' => false,
) );
$output .= '<ul id="' . $this->_id( '-status', false ) . '" class="cmb2-media-status cmb-attach-list">';
if ( $meta_value && is_array( $meta_value ) ) {
foreach ( $meta_value as $id => $fullurl ) {
$id_input = parent::render( array(
'type' => 'hidden',
'value' => $fullurl,
'name' => $name . '[' . $id . ']',
'id' => 'filelist-' . $id,
'data-id' => $id,
'desc' => '',
'class' => false,
) );
if ( $this->is_valid_img_ext( $fullurl ) ) {
$output .= $this->img_status_output( array(
'image' => wp_get_attachment_image( $id, $img_size ),
'tag' => 'li',
'id_input' => $id_input,
) );
} else {
$output .= $this->file_status_output( array(
'value' => $fullurl,
'tag' => 'li',
'id_input' => $id_input,
) );
}
}
}
$output .= '</ul>';
return $this->rendered( $output );
}
}

View File

@ -0,0 +1,110 @@
<?php
/**
* CMB Multi base field type
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
abstract class CMB2_Type_Multi_Base extends CMB2_Type_Base {
/**
* Generates html for an option element
*
* @since 1.1.0
* @param array $args Arguments array containing value, label, and checked boolean
* @return string Generated option element html
*/
public function select_option( $args = array() ) {
return sprintf( "\t" . '<option value="%s" %s>%s</option>', $args['value'], selected( isset( $args['checked'] ) && $args['checked'], true, false ), $args['label'] ) . "\n";
}
/**
* Generates html for list item with input
*
* @since 1.1.0
* @param array $args Override arguments
* @param int $i Iterator value
* @return string Gnerated list item html
*/
public function list_input( $args = array(), $i = '' ) {
$a = $this->parse_args( 'list_input', array(
'type' => 'radio',
'class' => 'cmb2-option',
'name' => $this->_name(),
'id' => $this->_id( $i ),
'value' => $this->field->escaped_value(),
'label' => '',
), $args );
return sprintf( "\t" . '<li><input%s/> <label for="%s">%s</label></li>' . "\n", $this->concat_attrs( $a, array( 'label' ) ), $a['id'], $a['label'] );
}
/**
* Generates html for list item with checkbox input
*
* @since 1.1.0
* @param array $args Override arguments
* @param int $i Iterator value
* @return string Gnerated list item html
*/
public function list_input_checkbox( $args, $i ) {
$saved_value = $this->field->escaped_value();
if ( is_array( $saved_value ) && in_array( $args['value'], $saved_value ) ) {
$args['checked'] = 'checked';
}
$args['type'] = 'checkbox';
return $this->list_input( $args, $i );
}
/**
* Generates html for concatenated items
*
* @since 1.1.0
* @param array $args Optional arguments
* @return string Concatenated html items
*/
public function concat_items( $args = array() ) {
$field = $this->field;
$method = isset( $args['method'] ) ? $args['method'] : 'select_option';
unset( $args['method'] );
$value = null !== $field->escaped_value()
? $field->escaped_value()
: $field->get_default();
$value = CMB2_Utils::normalize_if_numeric( $value );
$concatenated_items = '';
$i = 1;
$options = array();
if ( $option_none = $field->args( 'show_option_none' ) ) {
$options[''] = $option_none;
}
$options = $options + (array) $field->options();
foreach ( $options as $opt_value => $opt_label ) {
// Clone args & modify for just this item
$a = $args;
$a['value'] = $opt_value;
$a['label'] = $opt_label;
// Check if this option is the value of the input
if ( $value === CMB2_Utils::normalize_if_numeric( $opt_value ) ) {
$a['checked'] = 'checked';
}
$concatenated_items .= $this->$method( $a, $i++ );
}
return $concatenated_items;
}
}

View File

@ -0,0 +1,39 @@
<?php
/**
* CMB multicheck field type
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Type_Multicheck extends CMB2_Type_Radio {
/**
* The type of radio field
*
* @var string
*/
public $type = 'checkbox';
public function render( $args = array() ) {
$classes = false === $this->field->args( 'select_all_button' )
? 'cmb2-checkbox-list no-select-all cmb2-list'
: 'cmb2-checkbox-list cmb2-list';
$args = $this->parse_args( $this->type, array(
'class' => $classes,
'options' => $this->concat_items( array(
'name' => $this->_name() . '[]',
'method' => 'list_input_checkbox',
) ),
'desc' => $this->_desc( true ),
) );
return $this->rendered( $this->ul( $args ) );
}
}

View File

@ -0,0 +1,41 @@
<?php
/**
* CMB oembed field type
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Type_Oembed extends CMB2_Type_Text {
public function render( $args = array() ) {
$field = $this->field;
$meta_value = trim( $field->escaped_value() );
$oembed = ! empty( $meta_value )
? cmb2_ajax()->get_oembed( array(
'url' => $field->escaped_value(),
'object_id' => $field->object_id,
'object_type' => $field->object_type,
'oembed_args' => array(
'width' => '640',
),
'field_id' => $this->_id( '', false ),
) )
: '';
return parent::render( array(
'class' => 'cmb2-oembed regular-text',
'data-objectid' => $field->object_id,
'data-objecttype' => $field->object_type,
) )
. '<p class="cmb-spinner spinner"></p>'
. '<div id="' . $this->_id( '-status' ) . '" class="cmb2-media-status ui-helper-clearfix embed_wrap">' . $oembed . '</div>';
}
}

View File

@ -0,0 +1,56 @@
<?php
/**
* CMB Picker base field type
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
abstract class CMB2_Type_Picker_Base extends CMB2_Type_Text {
/**
* Parse the picker attributes.
*
* @since 2.2.0
* @param string $arg 'date' or 'time'
* @param array $args Optional arguments to modify (else use $this->field->args['attributes'])
* @return array Array of field attributes
*/
public function parse_picker_options( $arg = 'date', $args = array() ) {
$att = 'data-' . $arg . 'picker';
$update = empty( $args );
$atts = array();
$format = $this->field->args( $arg . '_format' );
if ( $js_format = CMB2_Utils::php_to_js_dateformat( $format ) ) {
if ( $update ) {
$atts = $this->field->args( 'attributes' );
} else {
$atts = isset( $args['attributes'] )
? $args['attributes']
: $atts;
}
// Don't override user-provided datepicker values
$data = isset( $atts[ $att ] )
? json_decode( $atts[ $att ], true )
: array();
$data[ $arg . 'Format' ] = $js_format;
$atts[ $att ] = function_exists( 'wp_json_encode' )
? wp_json_encode( $data )
: json_encode( $data );
}
if ( $update ) {
$this->field->args['attributes'] = $atts;
}
return array_merge( $args, $atts );
}
}

View File

@ -0,0 +1,52 @@
<?php
/**
* CMB radio field type
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Type_Radio extends CMB2_Type_Multi_Base {
/**
* The type of radio field
*
* @var string
*/
public $type = 'radio';
/**
* Constructor
*
* @since 2.2.2
*
* @param CMB2_Types $types
* @param array $args
*/
public function __construct( CMB2_Types $types, $args = array(), $type = '' ) {
parent::__construct( $types, $args );
$this->type = $type ? $type : $this->type;
}
public function render() {
$args = $this->parse_args( $this->type, array(
'class' => 'cmb2-radio-list cmb2-list',
'options' => $this->concat_items( array(
'label' => 'test',
'method' => 'list_input',
) ),
'desc' => $this->_desc( true ),
) );
return $this->rendered( $this->ul( $args ) );
}
protected function ul( $a ) {
return sprintf( '<ul class="%s">%s</ul>%s', $a['class'], $a['options'], $a['desc'] );
}
}

View File

@ -0,0 +1,30 @@
<?php
/**
* CMB select field type
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Type_Select extends CMB2_Type_Multi_Base {
public function render() {
$a = $this->parse_args( 'select', array(
'class' => 'cmb2_select',
'name' => $this->_name(),
'id' => $this->_id(),
'desc' => $this->_desc( true ),
'options' => $this->concat_items(),
) );
$attrs = $this->concat_attrs( $a, array( 'desc', 'options' ) );
return $this->rendered(
sprintf( '<select%s>%s</select>%s', $attrs, $a['options'], $a['desc'] )
);
}
}

View File

@ -0,0 +1,29 @@
<?php
/**
* CMB select_timezone field type
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Type_Select_Timezone extends CMB2_Type_Select {
public function render() {
$this->field->args['default'] = $this->field->get_default()
? $this->field->get_default()
: CMB2_Utils::timezone_string();
$this->args = wp_parse_args( $this->args, array(
'class' => 'cmb2_select cmb2-select-timezone',
'options' => wp_timezone_choice( $this->field->escaped_value() ),
'desc' => $this->_desc(),
) );
return parent::render();
}
}

View File

@ -0,0 +1,189 @@
<?php
/**
* CMB Taxonomy base field type
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
abstract class CMB2_Type_Taxonomy_Base extends CMB2_Type_Multi_Base {
/**
* Parent term ID when looping hierarchical terms.
*
* @var integer|null
*/
protected $parent = null;
/**
* Checks if we can get a post object, and if so, uses `get_the_terms` which utilizes caching.
*
* @since 1.0.2
* @return mixed Array of terms on success
*/
public function get_object_terms() {
switch ( $this->field->object_type ) {
case 'options-page':
case 'term':
return $this->options_terms();
case 'post':
// WP caches internally so it's better to use
return get_the_terms( $this->field->object_id, $this->field->args( 'taxonomy' ) );
default:
return $this->non_post_object_terms();
}
}
/**
* Gets the term objects for the terms stored via options boxes.
*
* @since 2.2.4
* @return mixed Array of terms on success
*/
public function options_terms() {
if ( empty( $this->field->value ) ) {
return array();
}
$terms = (array) $this->field->value;
foreach ( $terms as $index => $term ) {
$terms[ $index ] = get_term_by( 'slug', $term, $this->field->args( 'taxonomy' ) );
}
return $terms;
}
/**
* For non-post objects, wraps the call to wp_get_object_terms with transient caching.
*
* @since 2.2.4
* @return mixed Array of terms on success
*/
public function non_post_object_terms() {
$object_id = $this->field->object_id;
$taxonomy = $this->field->args( 'taxonomy' );
$cache_key = "cmb-cache-{$taxonomy}-{$object_id}";
// Check cache
$cached = get_transient( $cache_key );
if ( ! $cached ) {
$cached = wp_get_object_terms( $object_id, $taxonomy );
// Do our own (minimal) caching. Long enough for a page-load.
set_transient( $cache_key, $cached, 60 );
}
return $cached;
}
/**
* Wrapper for `get_terms` to account for changes in WP 4.6 where taxonomy is expected
* as part of the arguments.
*
* @since 2.2.2
* @return mixed Array of terms on success
*/
public function get_terms() {
$args = array(
'taxonomy' => $this->field->args( 'taxonomy' ),
'hide_empty' => false,
);
if ( null !== $this->parent ) {
$args['parent'] = $this->parent;
}
$args = wp_parse_args( $this->field->prop( 'query_args', array() ), $args );
return CMB2_Utils::wp_at_least( '4.5.0' )
? get_terms( $args )
: get_terms( $this->field->args( 'taxonomy' ), http_build_query( $args ) );
}
protected function no_terms_result( $error, $tag = 'li' ) {
if ( is_wp_error( $error ) ) {
$message = $error->get_error_message();
$data = 'data-error="' . esc_attr( $error->get_error_code() ) . '"';
} else {
$message = $this->_text( 'no_terms_text', esc_html__( 'No terms', 'cmb2' ) );
$data = '';
}
$this->field->args['select_all_button'] = false;
return sprintf( '<%3$s><label %1$s>%2$s</label></%3$s>', $data, esc_html( $message ), $tag );
}
public function get_object_term_or_default() {
$saved_terms = $this->get_object_terms();
return is_wp_error( $saved_terms ) || empty( $saved_terms )
? $this->field->get_default()
: array_shift( $saved_terms )->slug;
}
/**
* Takes a list of all tax terms and outputs.
*
* @since 2.2.5
*
* @param array $all_terms Array of all terms.
* @param array|string $saved Array of terms set to the object, or single term slug.
*
* @return string List of terms.
*/
protected function loop_terms( $all_terms, $saved_terms ) {
return '';
}
/**
* Build children hierarchy.
*
* @param object $parent_term The parent term object.
* @param array|string $saved Array of terms set to the object, or single term slug.
*
* @return string List of terms.
*/
protected function build_children( $parent_term, $saved ) {
if ( empty( $parent_term->term_id ) ) {
return '';
}
$this->parent = $parent_term->term_id;
$terms = $this->get_terms();
$options = '';
if ( ! empty( $terms ) && is_array( $terms ) ) {
$options .= $this->child_option_output( $terms, $saved );
}
return $options;
}
/**
* Build child terms output.
*
* @since 2.6.1
*
* @param array $terms Array of child terms.
* @param array|string $saved Array of terms set to the object, or single term slug.
*
* @return string Child option output.
*/
public function child_option_output( $terms, $saved ) {
$output = '<li class="cmb2-indented-hierarchy"><ul>';
$output .= $this->loop_terms( $terms, $saved );
$output .= '</ul></li>';
return $output;
}
}

View File

@ -0,0 +1,76 @@
<?php
/**
* CMB taxonomy_multicheck field type
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Type_Taxonomy_Multicheck extends CMB2_Type_Taxonomy_Base {
protected $counter = 0;
public function render() {
return $this->rendered(
$this->types->radio( array(
'class' => $this->get_wrapper_classes(),
'options' => $this->get_term_options(),
), 'taxonomy_multicheck' )
);
}
protected function get_term_options() {
$all_terms = $this->get_terms();
if ( ! $all_terms || is_wp_error( $all_terms ) ) {
return $this->no_terms_result( $all_terms );
}
return $this->loop_terms( $all_terms, $this->get_object_term_or_default() );
}
protected function loop_terms( $all_terms, $saved_terms ) {
$options = '';
foreach ( $all_terms as $term ) {
$options .= $this->list_term_input( $term, $saved_terms );
}
return $options;
}
protected function list_term_input( $term, $saved_terms ) {
$args = array(
'value' => $term->slug,
'label' => $term->name,
'type' => 'checkbox',
'name' => $this->_name() . '[]',
);
if ( is_array( $saved_terms ) && in_array( $term->slug, $saved_terms ) ) {
$args['checked'] = 'checked';
}
return $this->list_input( $args, ++$this->counter );
}
public function get_object_term_or_default() {
$saved_terms = $this->get_object_terms();
return is_wp_error( $saved_terms ) || empty( $saved_terms )
? $this->field->get_default()
: wp_list_pluck( $saved_terms, 'slug' );
}
protected function get_wrapper_classes() {
$classes = 'cmb2-checkbox-list cmb2-list';
if ( false === $this->field->args( 'select_all_button' ) ) {
$classes .= ' no-select-all';
}
return $classes;
}
}

View File

@ -0,0 +1,42 @@
<?php
/**
* CMB taxonomy_multicheck_hierarchical field type
*
* @since 2.2.5
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Type_Taxonomy_Multicheck_Hierarchical extends CMB2_Type_Taxonomy_Multicheck {
/**
* Parent term ID when looping hierarchical terms.
*
* @var integer
*/
protected $parent = 0;
public function render() {
return $this->rendered(
$this->types->radio( array(
'class' => $this->get_wrapper_classes(),
'options' => $this->get_term_options(),
), 'taxonomy_multicheck_hierarchical' )
);
}
protected function list_term_input( $term, $saved_terms ) {
$options = parent::list_term_input( $term, $saved_terms );
$children = $this->build_children( $term, $saved_terms );
if ( ! empty( $children ) ) {
$options .= $children;
}
return $options;
}
}

View File

@ -0,0 +1,92 @@
<?php
/**
* CMB taxonomy_radio field type
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Type_Taxonomy_Radio extends CMB2_Type_Taxonomy_Base {
protected $counter = 0;
public function render() {
return $this->rendered(
$this->types->radio( array(
'options' => $this->get_term_options(),
), 'taxonomy_radio' )
);
}
protected function get_term_options() {
$all_terms = $this->get_terms();
if ( ! $all_terms || is_wp_error( $all_terms ) ) {
return $this->no_terms_result( $all_terms );
}
$saved_term = $this->get_object_term_or_default();
$option_none = $this->field->args( 'show_option_none' );
$options = '';
if ( ! empty( $option_none ) ) {
$field_id = $this->_id( '', false );
/**
* Default (option-none) taxonomy-radio value.
*
* @since 1.3.0
*
* @param string $option_none_value Default (option-none) taxonomy-radio value.
*/
$option_none_value = apply_filters( 'cmb2_taxonomy_radio_default_value', '' );
/**
* Default (option-none) taxonomy-radio value.
*
* The dynamic portion of the hook name, $field_id, refers to the field id attribute.
*
* @since 1.3.0
*
* @param string $option_none_value Default (option-none) taxonomy-radio value.
*/
$option_none_value = apply_filters( "cmb2_taxonomy_radio_{$field_id}_default_value", $option_none_value );
$options .= $this->list_term_input( (object) array(
'slug' => $option_none_value,
'name' => $option_none,
), $saved_term );
}
$options .= $this->loop_terms( $all_terms, $saved_term );
return $options;
}
protected function loop_terms( $all_terms, $saved_term ) {
$options = '';
foreach ( $all_terms as $term ) {
$options .= $this->list_term_input( $term, $saved_term );
}
return $options;
}
protected function list_term_input( $term, $saved_term ) {
$args = array(
'value' => $term->slug,
'label' => $term->name,
);
if ( $saved_term == $term->slug ) {
$args['checked'] = 'checked';
}
return $this->list_input( $args, ++$this->counter );
}
}

View File

@ -0,0 +1,41 @@
<?php
/**
* CMB taxonomy_radio_hierarchical field type
*
* @since 2.2.5
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Type_Taxonomy_Radio_Hierarchical extends CMB2_Type_Taxonomy_Radio {
/**
* Parent term ID when looping hierarchical terms.
*
* @var integer
*/
protected $parent = 0;
public function render() {
return $this->rendered(
$this->types->radio( array(
'options' => $this->get_term_options(),
), 'taxonomy_radio_hierarchical' )
);
}
protected function list_term_input( $term, $saved_term ) {
$options = parent::list_term_input( $term, $saved_term );
$children = $this->build_children( $term, $saved_term );
if ( ! empty( $children ) ) {
$options .= $children;
}
return $options;
}
}

View File

@ -0,0 +1,102 @@
<?php
/**
* CMB taxonomy_select field type
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Type_Taxonomy_Select extends CMB2_Type_Taxonomy_Base {
/**
* Current Term Object.
*
* @since 2.6.1
*
* @var null|WP_Term
*/
public $current_term = null;
/**
* Saved Term Object.
*
* @since 2.6.1
*
* @var null|WP_Term
*/
public $saved_term = null;
public function render() {
return $this->rendered(
$this->types->select( array(
'options' => $this->get_term_options(),
) )
);
}
protected function get_term_options() {
$all_terms = $this->get_terms();
if ( ! $all_terms || is_wp_error( $all_terms ) ) {
return $this->no_terms_result( $all_terms, 'strong' );
}
$this->saved_term = $this->get_object_term_or_default();
$option_none = $this->field->args( 'show_option_none' );
$options = '';
if ( ! empty( $option_none ) ) {
$field_id = $this->_id( '', false );
/**
* Default (option-none) taxonomy-select value.
*
* @since 1.3.0
*
* @param string $option_none_value Default (option-none) taxonomy-select value.
*/
$option_none_value = apply_filters( 'cmb2_taxonomy_select_default_value', '' );
/**
* Default (option-none) taxonomy-select value.
*
* The dynamic portion of the hook name, $field_id, refers to the field id attribute.
*
* @since 1.3.0
*
* @param string $option_none_value Default (option-none) taxonomy-select value.
*/
$option_none_value = apply_filters( "cmb2_taxonomy_select_{$field_id}_default_value", $option_none_value );
$options .= $this->select_option( array(
'label' => $option_none,
'value' => $option_none_value,
'checked' => $this->saved_term == $option_none_value,
) );
}
$options .= $this->loop_terms( $all_terms, $this->saved_term );
return $options;
}
protected function loop_terms( $all_terms, $saved_term ) {
$options = '';
foreach ( $all_terms as $term ) {
$this->current_term = $term;
$options .= $this->select_option( array(
'label' => $term->name,
'value' => $term->slug,
'checked' => $this->saved_term === $term->slug,
) );
}
return $options;
}
}

View File

@ -0,0 +1,73 @@
<?php
/**
* CMB taxonomy_select_hierarchical field type
*
* @since 2.6.1
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Type_Taxonomy_Select_Hierarchical extends CMB2_Type_Taxonomy_Select {
/**
* Parent term ID when looping hierarchical terms.
*
* @since 2.6.1
*
* @var integer
*/
protected $parent = 0;
/**
* Child loop depth.
*
* @since 2.6.1
*
* @var integer
*/
protected $level = 0;
public function render() {
return $this->rendered(
$this->types->select( array(
'options' => $this->get_term_options(),
), 'taxonomy_select_hierarchical' )
);
}
public function select_option( $args = array() ) {
if ( $this->level > 0 ) {
$args['label'] = str_repeat( '&nbsp;&nbsp;&nbsp;&nbsp;', $this->level ) . $args['label'];
}
$option = parent::select_option( $args );
$children = $this->build_children( $this->current_term, $this->saved_term );
if ( ! empty( $children ) ) {
$option .= $children;
}
return $option;
}
/**
* Build children hierarchy.
*
* @since 2.6.1
*
* @param array $terms Array of child terms.
* @param array|string $saved Array of terms set to the object, or single term slug.
*
* @return string Child option output.
*/
public function child_option_output( $terms, $saved ) {
$this->level++;
$output = $this->loop_terms( $terms, $saved );
$this->level--;
return $output;
}
}

View File

@ -0,0 +1,61 @@
<?php
/**
* CMB text field type
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Type_Text extends CMB2_Type_Counter_Base {
/**
* The type of field
*
* @var string
*/
public $type = 'input';
/**
* Constructor
*
* @since 2.2.2
*
* @param CMB2_Types $types
* @param array $args
*/
public function __construct( CMB2_Types $types, $args = array(), $type = '' ) {
parent::__construct( $types, $args );
$this->type = $type ? $type : $this->type;
}
/**
* Handles outputting an 'input' element
*
* @since 1.1.0
* @param array $args Override arguments
* @return string Form input element
*/
public function render( $args = array() ) {
$args = empty( $args ) ? $this->args : $args;
$a = $this->parse_args( $this->type, array(
'type' => 'text',
'class' => 'regular-text',
'name' => $this->_name(),
'id' => $this->_id(),
'value' => $this->field->escaped_value(),
'desc' => $this->_desc( true ),
'js_dependencies' => array(),
), $args );
// Add character counter?
$a = $this->maybe_update_attributes_for_char_counter( $a );
return $this->rendered(
sprintf( '<input%s/>%s', $this->concat_attrs( $a, array( 'desc' ) ), $a['desc'] )
);
}
}

View File

@ -0,0 +1,30 @@
<?php
/**
* CMB text_date field type
*
* @since 2.2.2
*
* @category WordPress_Plugin
* @package CMB2
* @author CMB2 team
* @license GPL-2.0+
* @link https://cmb2.io
*/
class CMB2_Type_Text_Date extends CMB2_Type_Picker_Base {
public function render( $args = array() ) {
$args = $this->parse_args( 'text_date', array(
'class' => 'cmb2-text-small cmb2-datepicker',
'value' => $this->field->get_timestamp_format(),
'desc' => $this->_desc(),
'js_dependencies' => array( 'jquery-ui-core', 'jquery-ui-datepicker' ),
) );
if ( false === strpos( $args['class'], 'timepicker' ) ) {
$this->parse_picker_options( 'date' );
}
return parent::render( $args );
}
}

Some files were not shown because too many files have changed in this diff Show More