MPFT_RelatedPost

Extends MPFT

Delegate MEOW_Post

Methods

The UI and API implementation for the Related Post field type, augmented by Select2.

List of Methods

Property Methods

Manipulation

  • value_for_set( Mixed $value )Mixed

    Overrides the MPFT::value_for_set method to allow Related Post fields to be assigned a value in a number of different formats. A single post slug, ID, or MEOW_Post object.An array of post slugs, IDs, or MEOW_Post objects.A CSV string of post slugs or IDs.Note that this implementation will infer the appropriate post types to look for, based on the field type setup in MasterPress.

PHP Interface Method

  • count()Integer

    Return the count of posts selected in the UI.

  • offsetExists( Integer $index )Boolean

    Checks if the numerical array offset exists in the posts selected in the UI. Since this overrides offset-exists the offset test can be made by calling isset directly on the field object.

  • offsetGet( Integer $index )MEOW_Post OR WOOF_Silent

    Gets the post object at the given numerical array offset, if it exists. Since this overrides offset-get the post can be obtained by an array-style access directly on the field object – see example.

Internal Use

  • forward()Mixed

    Implements MPFT::forward to allow the field object to forward calls to this field type’s delegate.

  • get_delegate()MEOW_Post OR WOOF_Silent

    Implements MPFT::forward to return the first post, regardless of whether or not the field is setup to allow multiple posts to be selected (iterator-related methods are setup to regard the multiple items though).

  • is( Mixed $post, String $type )Boolean

    Overrides the MPFT::is method to allow the first or only post setup in this field to be checked for equality.

  • iterator_items()Array

    Allows the selected posts to be iterated with a foreach on the field object.

  • value_for_set( Mixed $value )Mixed

    Overrides the MPFT::value_for_set method to allow Related Post fields to be assigned a value in a number of different formats. A single post slug, ID, or MEOW_Post object.An array of post slugs, IDs, or MEOW_Post objects.A CSV string of post slugs or IDs.Note that this implementation will infer the appropriate post types to look for, based on the field type setup in MasterPress.

  • count()Integer

    Return the count of posts selected in the UI.

  • forward()Mixed

    Implements MPFT::forward to allow the field object to forward calls to this field type’s delegate.

  • get_delegate()MEOW_Post OR WOOF_Silent

    Implements MPFT::forward to return the first post, regardless of whether or not the field is setup to allow multiple posts to be selected (iterator-related methods are setup to regard the multiple items though).

  • is( Mixed $post, String $type )Boolean

    Overrides the MPFT::is method to allow the first or only post setup in this field to be checked for equality.

  • iterator_items()Array

    Allows the selected posts to be iterated with a foreach on the field object.

  • offsetExists( Integer $index )Boolean

    Checks if the numerical array offset exists in the posts selected in the UI. Since this overrides offset-exists the offset test can be made by calling isset directly on the field object.

  • offsetGet( Integer $index )MEOW_Post OR WOOF_Silent

    Gets the post object at the given numerical array offset, if it exists. Since this overrides offset-get the post can be obtained by an array-style access directly on the field object – see example.

  • page()MEOW_Post OR WOOF_Silent

    A synonym for the MPFT_RelatedPost::post method to return the first or only post selected.

  • post()MEOW_Post OR WOOF_Silent

    Retrieves the first or only post selected in the UI.

  • posts( Array / String $args )WOOF_Collection of MEOW_Post

    Retrieves a collection of the posts selected in the field UI. Note: you can further clarify the selected posts by setting the args parameter to a wp_parse_args compatible array or string. .

  • query_posts( Array / String $args )WOOF_Collection of MEOW_Post

    Retrieves the posts selected in the field UI, while also affecting the main WordPress query loop.

  • value()Array

    Overrides MPFT::value to return an array of integer post ids to represent the value of the field.

  • value_for_set( Mixed $value )Mixed

    Overrides the MPFT::value_for_set method to allow Related Post fields to be assigned a value in a number of different formats. A single post slug, ID, or MEOW_Post object.An array of post slugs, IDs, or MEOW_Post objects.A CSV string of post slugs or IDs.Note that this implementation will infer the appropriate post types to look for, based on the field type setup in MasterPress.

Delegate Methods

This class delegates to the MEOW_Post class, meaning it also supports the methods available in that class.

Base Class Methods

View method list from the base class MPFT.

Latest From the Blog

MasterPress 1.1.4 now available

MasterPress 1.1.4 is now available. This release contains an important compatibility fix for WordPress 4.5 to allow correct detection of the taxonomy term editing screen. Without this fix, any custom fields you have attached to custom taxonomies will not be shown at all in the editing form. Note also that MasterPress will still detect the edit screen correctly in… 

Plugin Requirements

MasterPress requires a minimum of WordPress version 3.4, MySQL 5, and PHP version 5.2.4.

We also recommend that PHP is configured to use a memory limit of 64MB per request (128MB may be required for sites with higher complexity).

This plug-in is not compatible with the WordPress.com hosted service.

Three AM Web + IT