it-swarm.dev

Como faço para criar um recurso de função personalizada?

Desejo criar um recurso personalizado para acessar a interface do meu plugin.

  • O plug-in deve gerenciar a adição desse recurso a todas as contas de administrador na ativação?
  • Em caso afirmativo: O WordPress gerencia a adição de recursos a todos os administradores de sub-blogs e superadministradores em instalações multisite, ou essa função precisa ser manipulada pelo plug-in?
25
rsman

Remova o que você adiciona

Primeiro, por favor, certifique-se de que tudo que você add on activation também receba removido na desinstalação. Eu tenho um pequeno tutorial incluindo código de exemplo para você.

Teste com um pequeno plugin:

Eu realmente não sei muito sobre MU, mas até onde eu sei, o objeto de papéis é global em todos os blogs. Apenas experimente este pequeno plugin e veja o que você pode obter:

<?php
/*
Plugin Name:    MU Roles check
Plugin URI:     https://github.com/franz-josef-kaiser/
Description:    Check roles during viewing a blog
Author:     Franz Josef Kaiser
Author URI:     https://plus.google.com/u/0/107110219316412982437
Version:        0.1
Text Domain:    murc
License:        GPL v2 - http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
*/

/**
 * Show the blog data and the role names in this blog
 * Also shows if the custom capability was successfully added, or displays n/a for the role
 * 
 * @return void
 */
function wpse35165_role_check()
{
    $blog = get_current_site();
    $custom_cap = 'name_of_your_custom_capability';

    $html = "<hr /><table>";
    $html .= "<caption>List roles in (Blog) {$blog->site_name} / ID#{$blog->id}</caption>"
    $html .= "<thead><tr><th>Role Name</th><th>Capabilties</th></tr></thead><tbody>";
    foreach ( $GLOBALS['wp_roles'] as $name => $role_obj )
    {
        $cap = in_array( $custom_cap, $role_obj->caps ) ? $custom_cap : 'n/a';
        $cap = $cap OR in_array( $custom_cap, $role_obj->allcaps ) ? $custom_cap : 'n/a';
        $html .= "<tr><td>{$name}</td><td>{$cap}</td></tr>";
    }
    $html .= '</tbody></table>';

    print $html;
}
add_action( 'shutdown', 'wpse35165_role_check' );

Adicionando Capacidades

/**
 * Add the capability to the role objects
 * Should be in your activation function and done before you inspect with your plugin
 * 
 * @return void
 */
function wpse35165_add_cap()
{
    $custom_cap = 'name_of_your_custom_capability';
    $min_cap    = 'the_minimum_required_built_in_cap'; // Check "Roles and objects table in codex!
    $grant      = true; 

    foreach ( $GLOBALS['wp_roles'] as $role_obj )
    {
        if ( 
            ! $role_obj->has_cap( $custom_cap ) 
            AND $role_obj->has_cap( $min_cap )
        )
            $role_obj->add_cap( $custom_cap, $grant );
    }
}

Nota: Você pode adicionar o recurso à função sem conceder acesso a ele - basta definir o segundo argumento $grant = false;. Isso permite que usuários únicos na lista de permissões simplesmente adicionem o limite, incluindo o último argumento, como verdadeiro.

10
kaiser

Para um plug-in no qual estou trabalhando atualmente, queria conceder/restringir o acesso às configurações do plug-in (por exemplo, as páginas de menu do administrador) em uma base por função.
Portanto, eu tive que adicionar uma nova capability específica do plugin para o user roles.

Infelizmente, resposta do kaiser parece não estar funcionando mais, então eu passei algum tempo tentando descobrir como permitir a funcionalidade acima mencionada.


O horário

Antes de compartilhar meu código com você, aqui está o que é, em texto simples:

  1. Na ativação do plug-in, inclua o novo recurso THE_NEW_CAP em funções com um determinado recurso interno BUILT_IN_CAP (no meu caso: edit_pages).
  2. Em cada carregamento de página, faça 1. (isto é, adicione a capacidade, novamente). Isso é necessário apenas se você quiser considerar possíveis novas funções que foram criadas após a ativação do plug-in. Portanto, essas novas funções não possuem o recurso específico do plug-in, mesmo que tenham o recurso interno necessário.
  3. Use o novo recurso para o que você quiser. Como explicado anteriormente, eu o uso para conceder/restringir o acesso às páginas de menu do administrador do plugin, assim é como é feito no exemplo de código a seguir.
  4. Na desativação do plug-in, remova o recurso. Claro, você também pode fazer isso quando o plug-in estiver sendo desinstalado. De qualquer maneira, faça isso eventualmente.

O código

E aqui está a lista acima convertida em código:

"Configurando

class WPSE35165Plugin {

    public function __construct() {
        // Register hooks
        register_activation_hook(__FILE__, array(__CLASS__, 'activation'));
        register_deactivation_hook(__FILE__, array(__CLASS__, 'deactivation'));

        // Add actions
        add_action('admin_menu', array(__CLASS__, 'admin_menu'));
    }

    public function activation() {
        self::add_cap();
    }

    // Add the new capability to all roles having a certain built-in capability
    private static function add_cap() {
        $roles = get_editable_roles();
        foreach ($GLOBALS['wp_roles']->role_objects as $key => $role) {
            if (isset($roles[$key]) && $role->has_cap('BUILT_IN_CAP')) {
                $role->add_cap('THE_NEW_CAP');
            }
        }
    }

" Usando isso

    // Add plugin menu pages to admin menu
    public function admin_menu() {
        // Remove the following line if you don't care about new roles
        // that have been created after plugin activation
        self::add_cap();

        // Set up the plugin admin menu
        add_menu_page('Menu', 'Menu', 'THE_NEW_CAP', …);
        add_submenu_page('wpse35165', 'Submenu', 'Submenu', 'THE_NEW_CAP', ...);
    }

"Limpando

    public function deactivation() {
        self::remove_cap();
    }

    // Remove the plugin-specific custom capability
    private static function remove_cap() {
        $roles = get_editable_roles();
        foreach ($GLOBALS['wp_roles']->role_objects as $key => $role) {
            if (isset($roles[$key]) && $role->has_cap('THE_NEW_CAP')) {
                $role->remove_cap('THE_NEW_CAP');
            }
        }
    }

}

Nota: Por favor, não use recursos em maiúsculas. Isso é apenas para facilitar a leitura.

17
tfrommen

Isso funciona para mim:

    add_action('admin_init', 'add_custom_cap');
    function add_custom_cap()
    {
        $custom_cap = 'test_cap';
        $min_cap    = 'read';
        $grant      = true;
        $to_role = 'your_user_role';
        $role = 'user_role';

        foreach ( $GLOBALS['wp_roles'] as $role_obj )
        {
            if (is_object($role_obj[$role])) {
                if (!$role_obj[$role]->has_cap( $custom_cap ) && $role_obj[$role]->has_cap( $min_cap )) {
                    $role_obj[$role]->add_cap( $custom_cap, $grant );
                }
            }
        }
    }
0
Vitaly Konurin