PHP Class PodsAdmin, pods

Afficher le fichier Open project: pods-framework/pods Class Usage Examples

Méthodes publiques

Свойство Type Description
$instance PodsAdmin

Méthodes publiques

Méthode Description
__construct ( ) : PodsAdmin Setup and Handle Admin functionality
add_rest_field_tab ( array $tabs ) : array Add REST field tab
add_rest_fields_to_field_editor ( array $options, array $pod ) : array Add a REST API section to advanced tab of field editor.
add_rest_settings_tab ( array $tabs, array $pod ) : array Add a rest api tab.
add_rest_settings_tab_fields ( array $options, array $pod ) : array Populate REST API tab.
admin_advanced ( ) Get advanced administration view.
admin_ajax ( ) Handle ajax calls for the administration
admin_capabilities ( $capabilities ) : array Add pods specific capabilities.
admin_components ( ) Get components administration UI
admin_components_toggle ( PodsUI $ui ) : boolean Toggle a component on or off
admin_content ( ) Create PodsUI content for the administration pages
admin_content_settings ( ) Create PodsUI content for the settings administration pages
admin_head ( ) Attach requirements to admin header
admin_help ( ) Get the admin help page
admin_init ( ) Init the admin area
admin_menu ( ) Build the admin menus
admin_settings ( ) Get settings administration view
admin_setup ( ) Handle main Pods Setup area for managing Pods and Fields
admin_setup_add ( $obj ) Get the add page of an object
admin_setup_delete ( $id, $obj ) : mixed Delete a pod
admin_setup_duplicate ( $obj ) : mixed Duplicate a pod
admin_setup_duplicate_restrict ( boolean $restricted, array $restrict, string $action, array $row, PodsUI $obj ) : boolean Restrict Duplicate action to custom types, not extended
admin_setup_edit ( $duplicate, $obj ) Get the edit page of an object
admin_setup_edit_field_options ( $pod ) : array Get list of Pod field options
admin_setup_edit_field_tabs ( $pod ) : array Get list of Pod field option tabs
admin_setup_edit_options ( $pod ) : array Get list of Pod options
admin_setup_edit_tabs ( $pod ) : array Get list of Pod option tabs
admin_setup_reset ( $obj, $id ) : mixed Reset a pod
admin_setup_reset_restrict ( boolean $restricted, array $restrict, string $action, array $row, PodsUI $obj ) Restrict Reset action from users and media
admin_upgrade ( ) Get the admin upgrade page
configuration ( $pod = null, boolean $full_field_info = false ) : array Profiles the Pods configuration
init ( ) : PodsAdmin Singleton handling for a basic pods_admin() request
mce_popup ( ) Output Pods shortcode popup window
media_button ( $context = null ) : string Add media button for Pods shortcode
parent_file ( $parent_file ) : mixed | string Set the correct parent_file to highlight the correct top level menu
register_media_assets ( ) Enqueue assets for Media Library Popup
upgrade_notice ( )

Méthodes protégées

Méthode Description
rest_admin ( ) Build UI for extending REST API, if makes sense to do so.
restable_pod ( array $pod ) : boolean Check if Pod type could extend core REST API response

Method Details

__construct() public méthode

Setup and Handle Admin functionality
Since: 2.0
public __construct ( ) : PodsAdmin
Résultat PodsAdmin

add_rest_field_tab() public méthode

Add REST field tab
Since: 2.5.6
public add_rest_field_tab ( array $tabs ) : array
$tabs array
Résultat array

add_rest_fields_to_field_editor() public méthode

Add a REST API section to advanced tab of field editor.
Since: 2.5.6
public add_rest_fields_to_field_editor ( array $options, array $pod ) : array
$options array
$pod array
Résultat array

add_rest_settings_tab() public méthode

Add a rest api tab.
Since: 2.6.0
public add_rest_settings_tab ( array $tabs, array $pod ) : array
$tabs array
$pod array
Résultat array

add_rest_settings_tab_fields() public méthode

Populate REST API tab.
Since: 0.1.0
public add_rest_settings_tab_fields ( array $options, array $pod ) : array
$options array
$pod array
Résultat array

admin_advanced() public méthode

Get advanced administration view.
public admin_advanced ( )

admin_ajax() public méthode

Handle ajax calls for the administration
public admin_ajax ( )

admin_capabilities() public méthode

Add pods specific capabilities.
public admin_capabilities ( $capabilities ) : array
$capabilities List of extra capabilities to add
Résultat array

admin_components() public méthode

Get components administration UI
public admin_components ( )

admin_components_toggle() public méthode

Toggle a component on or off
public admin_components_toggle ( PodsUI $ui ) : boolean
$ui PodsUI
Résultat boolean

admin_content() public méthode

Create PodsUI content for the administration pages
public admin_content ( )

admin_content_settings() public méthode

Create PodsUI content for the settings administration pages
public admin_content_settings ( )

admin_head() public méthode

Attach requirements to admin header
Since: 2.0
public admin_head ( )

admin_help() public méthode

Get the admin help page
public admin_help ( )

admin_init() public méthode

Init the admin area
Since: 2.0
public admin_init ( )

admin_menu() public méthode

Build the admin menus
Since: 2.0
public admin_menu ( )

admin_settings() public méthode

Get settings administration view
public admin_settings ( )

admin_setup() public méthode

Handle main Pods Setup area for managing Pods and Fields
public admin_setup ( )

admin_setup_add() public méthode

Get the add page of an object
public admin_setup_add ( $obj )
$obj

admin_setup_delete() public méthode

Delete a pod
public admin_setup_delete ( $id, $obj ) : mixed
$id
$obj
Résultat mixed

admin_setup_duplicate() public méthode

Duplicate a pod
public admin_setup_duplicate ( $obj ) : mixed
$obj
Résultat mixed

admin_setup_duplicate_restrict() public méthode

Restrict Duplicate action to custom types, not extended
Since: 2.3.10
public admin_setup_duplicate_restrict ( boolean $restricted, array $restrict, string $action, array $row, PodsUI $obj ) : boolean
$restricted boolean
$restrict array
$action string
$row array
$obj PodsUI
Résultat boolean

admin_setup_edit() public méthode

Get the edit page of an object
public admin_setup_edit ( $duplicate, $obj )
$duplicate
$obj

admin_setup_edit_field_options() public méthode

Get list of Pod field options
public admin_setup_edit_field_options ( $pod ) : array
Résultat array

admin_setup_edit_field_tabs() public méthode

Get list of Pod field option tabs
public admin_setup_edit_field_tabs ( $pod ) : array
Résultat array

admin_setup_edit_options() public méthode

Get list of Pod options
public admin_setup_edit_options ( $pod ) : array
Résultat array

admin_setup_edit_tabs() public méthode

Get list of Pod option tabs
public admin_setup_edit_tabs ( $pod ) : array
Résultat array

admin_setup_reset() public méthode

Reset a pod
public admin_setup_reset ( $obj, $id ) : mixed
$obj
Résultat mixed

admin_setup_reset_restrict() public méthode

Restrict Reset action from users and media
Since: 2.3.10
public admin_setup_reset_restrict ( boolean $restricted, array $restrict, string $action, array $row, PodsUI $obj )
$restricted boolean
$restrict array
$action string
$row array
$obj PodsUI

admin_upgrade() public méthode

Get the admin upgrade page
public admin_upgrade ( )

configuration() public méthode

Profiles the Pods configuration
Since: 3.0.0
public configuration ( $pod = null, boolean $full_field_info = false ) : array
$full_field_info boolean Optional. If true all info about each field is returned. If false, which is the default only name and type, will be returned.
Résultat array

init() public static méthode

Singleton handling for a basic pods_admin() request
Since: 2.3.5
public static init ( ) : PodsAdmin
Résultat PodsAdmin

mce_popup() public méthode

Output Pods shortcode popup window
public mce_popup ( )

media_button() public méthode

Add media button for Pods shortcode
public media_button ( $context = null ) : string
$context
Résultat string

parent_file() public méthode

Set the correct parent_file to highlight the correct top level menu
public parent_file ( $parent_file ) : mixed | string
$parent_file The parent file
Résultat mixed | string

register_media_assets() public méthode

Enqueue assets for Media Library Popup
public register_media_assets ( )

rest_admin() protected méthode

Build UI for extending REST API, if makes sense to do so.
Since: 2.6.0
protected rest_admin ( )

restable_pod() protected méthode

Check if Pod type could extend core REST API response
Since: 2.5.6
protected restable_pod ( array $pod ) : boolean
$pod array
Résultat boolean

upgrade_notice() public méthode

public upgrade_notice ( )

Property Details

$instance static_oe public_oe property

static public PodsAdmin $instance
Résultat PodsAdmin