Download the PHP package iceagency/lumberjack-posttypes-acf-fields without Composer
On this page you can find all versions of the php package iceagency/lumberjack-posttypes-acf-fields. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download iceagency/lumberjack-posttypes-acf-fields
More information about iceagency/lumberjack-posttypes-acf-fields
Files in iceagency/lumberjack-posttypes-acf-fields
Package lumberjack-posttypes-acf-fields
Short Description A Service Provider for the Lumberjack framework that allows you to define fields for your custom post types.
License MIT
Homepage https://github.com/ICEAgency/lumberjack-posttypes-acf-fields
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package lumberjack-posttypes-acf-fields
Post Type Fields for Lumberjack
A Service Provider for the Lumberjack framework that allows you to define fields for your custom post types.
Written & maintained by the team at The ICE Agency
Please note, this repo is not ready for production.
Roadmap
- Add support for repeater fields
- Add support for all field types that ACF offers
- Update documentation
Requirements
- PHP >=7.0
- Installation via Composer
- Lumberjack
- Advanced Custom Fields Pro
Installing
- Install Lumberjack, see the guide here.
-
Install via Composer:
- Add the provider within
Getting Started
-
Register your Post Type within
- Create your Post Type class within
-
Add the interface to your Post Type
-
For each field type you need to use, ensure that you include the relevent classes at the top of your Post Type class, for this example:
- Add a static method to define your field configuration, as follows:
Field Types
- Text:
- Text Area:
- Image:
- True/False:
- Checkbox:
- Email:
- File:
- Number:
- Page Link:
- Password:
- Post Object:
- Radio:
- Select:
- URL:
- User:
- WYSIWYG:
Generic Field Methods
create($name)
Create a field with the name given, this is the name that is used to retrieve the data with ACF's get_field() function
withLabel($label)
Set the label for the field within the WordPress Admin area.
isRequired()
Make the field required.
withInstructions($instructions)
Add instructions for the field.
withDefaultValue($default_value)
Add a default value to the field.
withPlaceholder($placeholder)
Used to set the placeholder for the field within the WordPress Admin area. (Please note, this is only possible on Text, TextArea, Number, Email, URL and Password)
Individual Field Methods
Text
withMaxLength($max_length)
Set maximum length of text (accepts integer).
isReadOnly()
Set field as read-only.
isDisabled()
Set field as disabled.
TextArea
withMaxLength($max_length)
Set maximum length of text (accepts integer).
isReadOnly()
Set field as read-only.
isDisabled()
Set field as disabled.
Image
withMinWidth($min_width)
Set minimum width in pixels (accepts integer)
withMinHeight($min_height)
Set minimum height in pixels (accepts integer)
withMaxWidth($max_width)
Set maximum width in pixels (accepts integer)
withMaxHeight($max_height)
Set maximum height in pixels (accepts integer)
withMinSize($min_size)
Set minimum size in MB (accepts integer)
withMaxSize($max_size)
Set maximum size in MB (accepts integer)
withMimeTypes($mime_types)
Comma-seperated list of mime types (e.g. "image/png,image/jpg,image/gif")
withReturnFormat($return_format)
Set the format that is returned, choose from "array", "url" or "id"
True/False
withMessage($message)
Set the message that appears with the checkbox
Checkbox
withOptions($options)
Set the checkbox items that appear, $options should be an array where the key is the checkbox value and the value represents the label of the checkbox.
File
withMinSize($min_size)
Set minimum size in MB (accepts integer)
withMaxSize($max_size)
Set maximum size in MB (accepts integer)
withMimeTypes($mime_types)
Comma-seperated list of mime types (e.g. "image/png,image/jpg,image/gif")
withReturnFormat($return_format)
Set the format that is returned, choose from "array", "url" or "id"
Number
withMin($min)
Set minimum number (accepts integer).
withMax($max)
Set maximum number (accepts integer).
withStep($step)
Set how many numbers are skipped when arrows are clicked (accepts integer).
Page Link
withPostTypes($post_types)
An array of post types that should be given as options.
withTaxonomy($taxonomy)
An array of taxonomies that contain the options that are given.
allowNull()
Set if the select can be set as null.
isMultiple()
Allow the user to select multiple options.
Post Object
withPostTypes($post_types)
An array of post types that should be given as options.
withTaxonomy($taxonomy)
An array of taxonomies that contain the options that are given.
allowNull()
Set if the select can be set as null.
isMultiple()
Allow the user to select multiple options.
withReturnFormat($return_format)
Choose the format that should be returned, choose between "object" and "id"
Radio
withOptions($options)
Set the checkbox items that appear, $options should be an array where the key is the checkbox value and the value represents the label of the checkbox.
Select
withOptions($options)
Set the checkbox items that appear, $options should be an array where the key is the checkbox value and the value represents the label of the checkbox.
allowNull()
Set if the select can be set as null.
isMultiple()
Allow the user to select multiple options.
User
withRoles($roles)
Set the roles of users that should appear in the select. Needs to be an array of user roles.
allowNull()
Set if the select can be set as null.
isMultiple()
Allow the user to select multiple options.
WYSIWYG
withTabs($tab_perference)
Set which tabs should show on the WYSIWYG, choose between "all", "visual" and "text"
withToolbar($toolbar_perference)
Set which toolbar to show in the WYSIWYG, choose between "full" and "basic"
canUploadMedia()
Set it so that the user can upload media with the WYSIWYG
